node_modules/v8-compile-cache/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

v8-compile-cache

v8-compile-cache attaches a require hook to use V8's code cache to speed up instantiation time. The "code cache" is the work of parsing and compiling done by V8.

The ability to tap into V8 to produce/consume this cache was introduced in Node v5.7.0.

Usage

1. Add the dependency:

sh $ npm install --save v8-compile-cache

1. Then, in your entry module add:

js require('v8-compile-cache');

Requiring v8-compile-cache in Node <5.7.0 is a noop – but you need at least Node 4.0.0 to support the ES2015 syntax used by v8-compile-cache.

Options

Set the environment variable DISABLE_V8_COMPILE_CACHE=1 to disable the cache.

Internals

The caches are stored in $TMP/v8-compile-cache/V8_VERSION, where there are .BLOB and .MAP files corresponding to the entry module that required v8-compile-cache. The cache is entry module specific because it is faster to load the entire code cache into memory at once, than it is to read it from disk on a file-by-file basis.

Benchmarks

See https://github.com/zertosh/v8-compile-cache/tree/master/bench.

Load Times:

| Module | Without Cache | With Cache | | ---------------- | -------------:| ----------:| | babel-core | 218ms | 185ms | | yarn | 153ms | 113ms | | yarn (bundled) | 228ms | 105ms |

^ Includes the overhead of loading the cache itself.

Acknowledgements

• FileSystemBlobStore and NativeCompileCache are based on Atom's implementation of their v8 compile cache:
• https://github.com/atom/atom/blob/b0d7a8a/src/file-system-blob-store.js
• https://github.com/atom/atom/blob/b0d7a8a/src/native-compile-cache.js
• mkdirpSync is based on:
• https://github.com/substack/node-mkdirp/blob/f2003bb/index.js#L55-L98

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.