cacache     

cacache is a Node.js library for managing
local key and content address caches. It's really fast, really good at
concurrency, and it will never give you corrupted data, even if cache files
get corrupted or manipulated.

On systems that support user and group settings on files, cacache will
match the uid and gid values to the folder where the cache lives, even
when running as root.

It was written to be used as npm's local cache, but can
just as easily be used on its own.

Install

$ npm install --save cacache

Table of Contents

* Example
* Features
* Contributing
* API
* Using localized APIs
* Reading
* ls
* ls.stream
* get
* get.stream
* get.info
* get.hasContent
* Writing
* put
* put.stream
* rm.all
* rm.entry
* rm.content
* index.compact
* index.insert
* Utilities
* clearMemoized
* tmp.mkdir
* tmp.withTmp
* Integrity
* Subresource Integrity
* verify
* verify.lastRun

$3

``javascript
const cacache = require('cacache')
const fs = require('fs')

const cachePath = '/tmp/my-toy-cache'
const key = 'my-unique-key-1234'

// Cache it! Use cachePath as the root of the content cache
cacache.put(cachePath, key, '10293801983029384').then(integrity => {
console.log(Saved content to ${cachePath}.)
})

const destination = '/tmp/mytar.tgz'

// Copy the contents out of the cache and into their destination!
// But this time, use stream instead!
cacache.get.stream(
cachePath, key
).pipe(
fs.createWriteStream(destination)
).on('finish', () => {
console.log('done extracting!')
})

// The same thing, but skip the key index.
cacache.get.byDigest(cachePath, integrityHash).then(data => {
fs.writeFile(destination, data, err => {
console.log('tarball data fetched based on its sha512sum and written out!')
})
})
`

$3

* Extraction by key or by content address (shasum, etc)
* Subresource Integrity web standard support
* Multi-hash support - safely host sha1, sha512, etc, in a single cache
* Automatic content deduplication
* Fault tolerance (immune to corruption, partial writes, process races, etc)
* Consistency guarantees on read and write (full data verification)
* Lockless, high-concurrency cache access
* Streaming support
* Promise support
* Fast -- sub-millisecond reads and writes including verification
* Arbitrary metadata storage
* Garbage collection and additional offline verification
* Thorough test coverage
* There's probably a bloom filter in there somewhere. Those are cool, right? 🤔

$3

The cacache team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

All participants and maintainers in this project are expected to follow Code of Conduct, and just generally be excellent to each other.

Please refer to the Changelog for project history details, too.

Happy hacking!

$3

#### > cacache.ls(cache) -> Promise