# read-file-cache [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/read-file-cache) [](https://www.npmjs.com/package/read-file-cache) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) > Read files and cache them. ## :cloud: Installation ```sh # Using npm npm install --save read-file-cache # Using yarn yarn add read-file-cache ``` ## :clipboard: Example ```js 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: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :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][contributing]. ## :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: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—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`  Thanks! :heart: ## :scroll: License [MIT][license] © [Ionică Bizău][website] [license]: /LICENSE [website]: https://ionicabizau.net [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW