summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-edit.3
blob: ceb99ec01f674df6ff88d34091abeb52f07af777 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.TH "NPM\-EDIT" "3" "June 2015" "" ""
.SH "NAME"
\fBnpm-edit\fR \- Edit an installed package
.SH SYNOPSIS
.P
.RS 2
.nf
npm\.commands\.edit(package, callback)
.fi
.RE
.SH DESCRIPTION
.P
Opens the package folder in the default editor (or whatever you've
configured as the npm \fBeditor\fR config \-\- see \fBnpm help config\fR\|\.)
.P
After it has been edited, the package is rebuilt so as to pick up any
changes in compiled packages\.
.P
For instance, you can do \fBnpm install connect\fR to install connect
into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fR
to make a few changes to your locally installed copy\.
.P
The first parameter is a string array with a single element, the package
to open\. The package can optionally have a version number attached\.
.P
Since this command opens an editor in a new process, be careful about where
and how this is used\.