Read-file-cache NPM

read-file-cache

Read files and cache them.

:cloud: Installation

# Using npm
npm install --save read-file-cache

# Using yarn
yarn add read-file-cache

:clipboard: Example

const readFileCache = require("read-file-cache");

// Read the file from the disk
readFileCache("~/.bashrc", (err, content) => {
    console.log(err || content);

    // Read it from the cache
    readFileCache("~/.bashrc", (err, content) => {
        console.log(err || content);

        // And now force reading it from the disk again
        readFileCache("~/.bashrc", true, (err, content) => {
            console.log(err || content);
        });
    });
});

// From the disk
console.log(readFileCache.sync("~/.bashrc"));

// From cache
console.log(readFileCache.sync("~/.bashrc"));

// Force reading from disk
console.log(readFileCache.sync("~/.bashrc", true));

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`readFileCache(path, noCache, cb)`

Reads the file asyncronously.

Params

String path: The file path.
Boolean noCache: If true, the file will be read from the disk.
Function cb: The callback function.

`sync(path, noCache)`

The syncronous version of the function.

Params

String path: The file path.
Boolean noCache: If true, the file will be read from the disk.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6