dryrun
v1.0.2
Published
Checks the DRY_RUN environment variable
Downloads
348
Keywords
Readme
Dryrun
Checks if the DRY_RUN
environment variable is set to a truthy value. It considers any value truthy
other than: unset
, ""
, "0"
, "false"
and "no"
.
Usage
Simply install with npm or yarn:
npm install dryrun
yarn add dryrun
To use it, import the isDryRun
or shouldPerform
functions:
const { isDryRun, shouldPerform } = require('dryrun');
console.log(isDryRun()); // true if DRY_RUN was set
console.log(shouldPerform()); // opposite of isDryRun()
Testing
dryrun
comes with two handy functions for testing:
const { resetDryRun, setDryRun } = require('dryrun');
setDryRun(true); // explicitly activate DRY_RUN
...
resetDryRun(); // reset DRY_RUN to the environment value