diff options
Diffstat (limited to 'deps/node/deps/npm/html/doc/cli/npm-cache.html')
| -rw-r--r-- | deps/node/deps/npm/html/doc/cli/npm-cache.html | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/deps/node/deps/npm/html/doc/cli/npm-cache.html b/deps/node/deps/npm/html/doc/cli/npm-cache.html new file mode 100644 index 00000000..0193feab --- /dev/null +++ b/deps/node/deps/npm/html/doc/cli/npm-cache.html @@ -0,0 +1,92 @@ +<!doctype html> +<html> + <title>npm-cache</title> + <meta charset="utf-8"> + <link rel="stylesheet" type="text/css" href="../../static/style.css"> + <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-cache.html"> + <script async=true src="../../static/toc.js"></script> + + <body> + <div id="wrapper"> + +<h1><a href="../cli/npm-cache.html">npm-cache</a></h1> <p>Manipulates packages cache</p> +<h2 id="synopsis">SYNOPSIS</h2> +<pre><code>npm cache add <tarball file> +npm cache add <folder> +npm cache add <tarball url> +npm cache add <name>@<version> + +npm cache clean [<path>] +aliases: npm cache clear, npm cache rm + +npm cache verify</code></pre><h2 id="description">DESCRIPTION</h2> +<p>Used to add, list, or clean the npm cache folder.</p> +<ul> +<li><p>add: +Add the specified package to the local cache. This command is primarily +intended to be used internally by npm, but it can provide a way to +add data to the local installation cache explicitly.</p> +</li> +<li><p>clean: +Delete all data out of the cache folder.</p> +</li> +<li><p>verify: +Verify the contents of the cache folder, garbage collecting any unneeded data, +and verifying the integrity of the cache index and all cached data.</p> +</li> +</ul> +<h2 id="details">DETAILS</h2> +<p>npm stores cache data in an opaque directory within the configured <code>cache</code>, +named <code>_cacache</code>. This directory is a <code>cacache</code>-based content-addressable cache +that stores all http request data as well as other package-related data. This +directory is primarily accessed through <code>pacote</code>, the library responsible for +all package fetching as of npm@5.</p> +<p>All data that passes through the cache is fully verified for integrity on both +insertion and extraction. Cache corruption will either trigger an error, or +signal to <code>pacote</code> that the data must be refetched, which it will do +automatically. For this reason, it should never be necessary to clear the cache +for any reason other than reclaiming disk space, thus why <code>clean</code> now requires +<code>--force</code> to run.</p> +<p>There is currently no method exposed through npm to inspect or directly manage +the contents of this cache. In order to access it, <code>cacache</code> must be used +directly.</p> +<p>npm will not remove data by itself: the cache will grow as new packages are +installed.</p> +<h2 id="a-note-about-the-caches-design">A NOTE ABOUT THE CACHE'S DESIGN</h2> +<p>The npm cache is strictly a cache: it should not be relied upon as a persistent +and reliable data store for package data. npm makes no guarantee that a +previously-cached piece of data will be available later, and will automatically +delete corrupted contents. The primary guarantee that the cache makes is that, +if it does return data, that data will be exactly the data that was inserted.</p> +<p>To run an offline verification of existing cache contents, use <code>npm cache +verify</code>.</p> +<h2 id="configuration">CONFIGURATION</h2> +<h3 id="cache">cache</h3> +<p>Default: <code>~/.npm</code> on Posix, or <code>%AppData%/npm-cache</code> on Windows.</p> +<p>The root cache folder.</p> +<h2 id="see-also">SEE ALSO</h2> +<ul> +<li><a href="../files/npm-folders.html">npm-folders(5)</a></li> +<li><a href="../cli/npm-config.html">npm-config(1)</a></li> +<li><a href="../misc/npm-config.html">npm-config(7)</a></li> +<li><a href="../files/npmrc.html">npmrc(5)</a></li> +<li><a href="../cli/npm-install.html">npm-install(1)</a></li> +<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li> +<li><a href="../cli/npm-pack.html">npm-pack(1)</a></li> +<li><a href="https://npm.im/cacache">https://npm.im/cacache</a></li> +<li><a href="https://npm.im/pacote">https://npm.im/pacote</a></li> +</ul> + +</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@6.7.0</p> + |