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

   1 <!doctype html>
   2 <html>
   3   <title>npm-cache</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-cache.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../api/npm-cache.html">npm-cache</a></h1> <p>manage the npm cache programmatically</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm.commands.cache([args], callback)
  15
  16 // helpers
  17 npm.commands.cache.clean([args], callback)
  18 npm.commands.cache.add([args], callback)
  19 npm.commands.cache.read(name, version, forceBypass, callback)
  20 </code></pre><h2 id="description">DESCRIPTION</h2>
  21 <p>This acts much the same ways as the <a href="../cli/npm-cache.html">npm-cache(1)</a> command line
  22 functionality.</p>
  23 <p>The callback is called with the package.json data of the thing that is
  24 eventually added to or read from the cache.</p>
  25 <p>The top level <code>npm.commands.cache(...)</code> functionality is a public
  26 interface, and like all commands on the <code>npm.commands</code> object, it will
  27 match the command line behavior exactly.</p>
  28 <p>However, the cache folder structure and the cache helper functions are
  29 considered <strong>internal</strong> API surface, and as such, may change in future
  30 releases of npm, potentially without warning or significant version
  31 incrementation.</p>
  32 <p>Use at your own risk.</p>
  33
  34 </div>
  35
  36 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  37 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  38 <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>
  39 <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>
  40 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  41 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  42 <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>
  43 <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>
  44 </table>
  45 <p id="footer">npm-cache &mdash; npm@2.14.4</p>
  46