deps/npm/html/doc/api/npm-edit.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-edit</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-edit.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../api/npm-edit.html">npm-edit</a></h1> <p>Edit an installed package</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm.commands.edit(package, callback)
  15 </code></pre><h2 id="description">DESCRIPTION</h2>
  16 <p>Opens the package folder in the default editor (or whatever you&#39;ve
  17 configured as the npm <code>editor</code> config -- see <code>npm help config</code>.)</p>
  18 <p>After it has been edited, the package is rebuilt so as to pick up any
  19 changes in compiled packages.</p>
  20 <p>For instance, you can do <code>npm install connect</code> to install connect
  21 into your package, and then <code>npm.commands.edit([&quot;connect&quot;], callback)</code>
  22 to make a few changes to your locally installed copy.</p>
  23 <p>The first parameter is a string array with a single element, the package
  24 to open. The package can optionally have a version number attached.</p>
  25 <p>Since this command opens an editor in a new process, be careful about where
  26 and how this is used.</p>
  27
  28 </div>
  29
  30 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  31 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  32 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  33 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  34 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  35 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  36 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  37 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  38 </table>
  39 <p id="footer">npm-edit &mdash; npm@2.14.4</p>
  40