revertable-globals

Sets globals in a JavaScript environment that can be easily reverted to restore the original environment; useful for testing code that relies on the presence of certain globals.

Installation

For Node.js, to install revertable-globals with npm, run:

npm install revertable-globals --save-dev

For Deno, an example import map:

{
  "imports": {
    "revertable-globals": "https://unpkg.com/revertable-globals@4.0.0/revertableGlobals.mjs"
  }
}

Then, import and use the function revertableGlobals.

Requirements

Supported runtime environments:

Node.js versions ^14.17.0 || ^16.0.0 || >= 18.0.0.
Deno.

Non Deno projects must configure TypeScript to use types from the ECMAScript modules that have a // @ts-check comment:

compilerOptions.allowJs should be true.
compilerOptions.maxNodeModuleJsDepth should be reasonably large, e.g. 10.
compilerOptions.module should be "node16" or "nodenext".

Exports

The npm package revertable-globals features optimal JavaScript module design. These ECMAScript modules are exported via the package.json field exports:

revertableGlobals.mjs