summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/edit.3
blob: 3212032a8485c6b46f4dcfc2ed05fe09ebc2edab (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
29
30
31
32
33
34
35
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-EDIT" "3" "June 2013" "" ""
.
.SH "NAME"
\fBnpm-edit\fR \-\- Edit an installed package
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.edit(package, callback)
.
.fi
.
.SH "DESCRIPTION"
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\.