Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bevry/requirefresh
Require a file without adding it into the require cache
https://github.com/bevry/requirefresh
nodejs nodejs-modules
Last synced: about 1 month ago
JSON representation
Require a file without adding it into the require cache
- Host: GitHub
- URL: https://github.com/bevry/requirefresh
- Owner: bevry
- License: other
- Created: 2013-08-30T01:58:13.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-12-30T16:35:12.000Z (11 months ago)
- Last Synced: 2024-04-14T02:34:16.747Z (7 months ago)
- Topics: nodejs, nodejs-modules
- Language: TypeScript
- Size: 1.23 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Require Fresh
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
#### 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)