diff options
| author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2019-10-06 21:37:45 +0200 |
|---|---|---|
| committer | Dimitri Staessens <dimitri@ouroboros.rocks> | 2019-10-06 21:37:45 +0200 |
| commit | 3c51c3be85bb0d1bdb87ea0d6632f1c256912f27 (patch) | |
| tree | c7ccc8279b12c4f7bdbbb4270d617e48f51722e4 /node_modules/read-cache/README.md | |
| parent | 412c104bebc507bea9c94fd53b5bdc4b64cbfe31 (diff) | |
| download | website-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.tar.gz website-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.zip | |
build: Add some required modules for node
Diffstat (limited to 'node_modules/read-cache/README.md')
| -rw-r--r-- | node_modules/read-cache/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/read-cache/README.md b/node_modules/read-cache/README.md new file mode 100644 index 0000000..16a5c36 --- /dev/null +++ b/node_modules/read-cache/README.md @@ -0,0 +1,46 @@ +# read-cache [](https://travis-ci.org/TrySound/read-cache)
+
+Reads and caches the entire contents of a file until it is modified.
+
+
+## Install
+
+```
+$ npm i read-cache
+```
+
+
+## Usage
+
+```js
+// foo.js
+var readCache = require('read-cache');
+
+readCache('foo.js').then(function (contents) {
+ console.log(contents);
+});
+```
+
+
+## API
+
+### readCache(path[, encoding])
+
+Returns a promise that resolves with the file's contents.
+
+### readCache.sync(path[, encoding])
+
+Returns the content of the file.
+
+### readCache.get(path[, encoding])
+
+Returns the content of cached file or null.
+
+### readCache.clear()
+
+Clears the contents of the cache.
+
+
+## License
+
+MIT © [Bogdan Chadkin](mailto:trysound@yandex.ru)
|