aboutsummaryrefslogtreecommitdiff
path: root/node_modules/require-precompiled/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/require-precompiled/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/require-precompiled/readme.md')
-rw-r--r--node_modules/require-precompiled/readme.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/require-precompiled/readme.md b/node_modules/require-precompiled/readme.md
new file mode 100644
index 000000000..23fdc751b
--- /dev/null
+++ b/node_modules/require-precompiled/readme.md
@@ -0,0 +1,45 @@
+# require-precompiled [![Build Status](https://travis-ci.org/jamestalmage/require-precompiled.svg?branch=master)](https://travis-ci.org/jamestalmage/require-precompiled) [![Coverage Status](https://coveralls.io/repos/jamestalmage/require-precompiled/badge.svg?branch=master&service=github)](https://coveralls.io/github/jamestalmage/require-precompiled?branch=master)
+
+> Require extension that allows for caching/precompiling
+
+
+## Install
+
+```
+$ npm install --save require-precompiled
+```
+
+
+## Usage
+
+```js
+const installPrecompiler = require('require-precompiled');
+const cache = require('my-cache-implementation');
+
+installPrecompiler(filename => {
+ if (cache.hasEntryFor(filename)) {
+ return cache.getPrecompiledCode(filename);
+ }
+ // fall through to underlying extension chain;
+ return null;
+});
+
+// Any module required from this point on will be checked against the cache.
+const foo = require('some-module');
+```
+
+
+## API
+
+### requirePrecompiled(callback)
+
+#### callback
+
+Type: `Function(string: filename)`
+
+Return `string` contents for a cache hit, or `null` for a miss.
+
+
+## License
+
+MIT © [James Talmage](http://github.com/jamestalmage)