https://github.com/shinnn/npcache

Manipulate cache of npm packages
https://github.com/shinnn/npcache

cache javascript nodejs npm promise stream

Last synced: 27 days ago
JSON representation

Manipulate cache of npm packages

• Host: GitHub
• URL: https://github.com/shinnn/npcache
• Owner: shinnn
• License: isc
• Created: 2018-08-17T03:47:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-07-11T15:15:13.000Z (over 5 years ago)
• Last Synced: 2024-10-09T09:24:11.278Z (about 1 month ago)
• Topics: cache, javascript, nodejs, npm, promise, stream
• Language: JavaScript
• Size: 158 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npcache

[![npm version](https://img.shields.io/npm/v/npcache.svg)](https://www.npmjs.com/package/npcache)

[![Build Status](https://travis-ci.com/shinnn/npcache.svg?branch=master)](https://travis-ci.com/shinnn/npcache)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/npcache.svg)](https://coveralls.io/github/shinnn/npcache?branch=master)

Manipulate cache of npm packages

```javascript

const npcache = require('npcache');

(async () => {

  const cache = await npcache.get('make-fetch-happen:request-cache:https://registry.npmjs.org/glob');

  cache.metadata; //=> {url: 'https://registry.npmjs.org/glob', ...}

  cache.data; //=> 

  cache.size; //=> 37086  

  cache.integrity; //=> 'sha512-Non1RHdlmK+8lJaN1a88N ...'

})();

```

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install npcache

```

## API

```javascript

const npcache = require('npcache');

```

### npcache

The API is based on [cacache](https://github.com/npm/cacache), a cache manipulation library used inside [npm CLI](https://github.com/npm/cli).

Note the following differences:

* Original `cache` parameters are omitted, and it defaults to [`_cacache` in the npm cache directory](https://docs.npmjs.com/cli/cache#details).

* Method aliases, for example `cacache.rm.entry` → `cacache.rm`, are removed.

* [`clearMemoized()`](https://github.com/npm/cacache#clear-memoized) returns a `Promise` instead of `undefined`.

* [`setLocale()`](https://github.com/npm/cacache#set-locale) method is not supported.

```javascript

(async () => {

  for await (const {path} of npcache.ls.stream()) {

    console.log(path);

  }

})();

```

```

/Users/shinnn/.npm/_cacache/content-v2/sha512/a6/12/5f41506e689339ada ...

/Users/shinnn/.npm/_cacache/content-v2/sha512/ff/1a/f50039b96e74e38cd ...

/Users/shinnn/.npm/_cacache/content-v2/sha512/0b/61/241d7c17bcbb1baee ...

/Users/shinnn/.npm/_cacache/content-v2/sha512/39/a5/358478e025ff9bd0d ...

...

```

## License

[ISC License](./LICENSE) © 2018 - 2019 Watanabe Shinnosuke