requirefresh

# Require Fresh   <a href="https://github.com/bevry/requirefresh/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/requirefresh/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a> <a href="https://npmjs.org/package/requirefresh" title="View this project on NPM"><img src="https://img.shields.io/npm/v/requirefresh.svg" alt="NPM version" /></a> <a href="https://npmjs.org/package/requirefresh" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/requirefresh.svg" alt="NPM downloads" /></a> <a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a> <a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a> <a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a> <a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a> <a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a> <a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a> <a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a> <a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a> <a href="https://discord.gg/nQuXddV7VP" title="Join this project's community on Discord"><img src="https://img.shields.io/discord/1147436445783560193?logo=discord&label=discord" alt="Discord server badge" /></a> <a href="https://www.twitch.tv/balupton" title="Join this project's community on Twitch"><img src="https://img.shields.io/twitch/status/balupton?logo=twitch" alt="Twitch community badge" /></a>   Require a file without adding it into the require cache  ## Usage [Complete API Documentation.](http://master.requirefresh.bevry.surge.sh/docs/) Here is an example that uses Require Fresh to load the `package.json` file without caching. ```javascript // Import const { requireFresh, requireFreshCallback, requireFreshPromise, } = require('requirefresh') // Require the module freshly synchronously (will throw errors) try { const result = requireFresh('./package.json') console.log(result) } catch (error) { console.error(error) } // Require the fresh module synchronously via a callback that contains the error and result requireFreshCallback('./package.json', function (error, result) { if (error) { console.error(error) } else { console.log(result) } }) // Require the fresh module synchronously via a promise requireFreshPromise('./package.json') .then((result) => console.log(result)) .catch((error) => console.error(error)) ```  ## Install ### [npm](https://npmjs.com "npm is a package manager for javascript") - Install: `npm install --save requirefresh` - Import: `import pkg from ('requirefresh')` - Require: `const pkg = require('requirefresh').default` ### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js") ``` typescript import pkg from 'https://unpkg.com/requirefresh@^5.13.0/edition-deno/index.ts' ``` ### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.") This package is published with the following editions: - `requirefresh/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules - `requirefresh` aliases `requirefresh/edition-es2022/index.js` - `requirefresh/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules - `requirefresh/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules - `requirefresh/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")   ## History [Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/requirefresh/blob/HEAD/HISTORY.md#files)   ## Backers ### Code [Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/requirefresh/blob/HEAD/CONTRIBUTING.md#files) #### Authors - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom. #### Maintainers - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom. #### Contributors - [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/requirefresh/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/requirefresh") - [Sean Fridman](https://github.com/sfrdmn) — [view contributions](https://github.com/bevry/requirefresh/commits?author=sfrdmn "View the GitHub contributions of Sean Fridman on repository bevry/requirefresh") ### Finances <a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a> <a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a> <a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a> <a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a> <a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a> <a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a> <a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a> <a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a> #### Sponsors - [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher - [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders. - [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing. - [Poonacha Medappa](https://poonachamedappa.com) - [Rob Morris](https://github.com/Rob-Morris) - [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games. - [Syntax](https://syntax.fm) — Syntax Podcast #### Donors - [Andrew Nesbitt](https://nesbitt.io) - [Armen Mkrtchian](https://mogoni.dev) - [Balsa](https://balsa.com) - [Chad](https://opencollective.com/chad8) - [Codecov](https://codecov.io) - [dr.dimitru](https://veliovgroup.com) - [Elliott Ditman](https://elliottditman.com) - [entroniq](https://gitlab.com/entroniq) - [GitHub](https://github.com/about) - [Hunter Beast](https://cryptoquick.com) - [Jean-Luc Geering](https://github.com/jlgeering) - [Michael Duane Mooring](https://mdm.cc) - [Michael Harry Scepaniak](https://michaelscepaniak.com) - [Mohammed Shah](https://github.com/smashah) - [Mr. Henry](https://mrhenry.be) - [Nermal](https://arjunaditya.vercel.app) - [Pleo](https://pleo.io) - [Poonacha Medappa](https://poonachamedappa.com) - [Rob Morris](https://github.com/Rob-Morris) - [Robert de Forest](https://github.com/rdeforest) - [Sentry](https://sentry.io) - [ServieJS](https://github.com/serviejs) - [Skunk Team](https://skunk.team) - [Syntax](https://syntax.fm) - [WriterJohnBuck](https://github.com/WriterJohnBuck)   ## License Unless stated otherwise all works are: - Copyright © [Benjamin Lupton](https://balupton.com) and licensed under: - [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)