| <!doctype html> |
| <html> |
| <title>npm-cache</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-cache.html"> |
| <script async=true src="../../static/toc.js"></script> |
| |
| <body> |
| <div id="wrapper"> |
| |
| <h1><a href="../api/npm-cache.html">npm-cache</a></h1> <p>manage the npm cache programmatically</p> |
| <h2 id="synopsis">SYNOPSIS</h2> |
| <pre><code>npm.commands.cache([args], callback) |
| |
| // helpers |
| npm.commands.cache.clean([args], callback) |
| npm.commands.cache.add([args], callback) |
| npm.commands.cache.read(name, version, forceBypass, callback) |
| </code></pre><h2 id="description">DESCRIPTION</h2> |
| <p>This acts much the same ways as the <a href="../cli/npm-cache.html">npm-cache(1)</a> command line |
| functionality.</p> |
| <p>The callback is called with the package.json data of the thing that is |
| eventually added to or read from the cache.</p> |
| <p>The top level <code>npm.commands.cache(...)</code> functionality is a public |
| interface, and like all commands on the <code>npm.commands</code> object, it will |
| match the command line behavior exactly.</p> |
| <p>However, the cache folder structure and the cache helper functions are |
| considered <strong>internal</strong> API surface, and as such, may change in future |
| releases of npm, potentially without warning or significant version |
| incrementation.</p> |
| <p>Use at your own risk.</p> |
| |
| </div> |
| |
| <table border=0 cellspacing=0 cellpadding=0 id=npmlogo> |
| <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> |
| <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> |
| <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff"> </td></tr> |
| <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> |
| <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> |
| </table> |
| <p id="footer">npm-cache — npm@2.15.8</p> |
| |
