first-run
v3.0.0
Published
Check if it's the first time the process is run
Downloads
2,016
Maintainers
Readme
first-run
Check if it's the first time the process is run
Can be used to greet the user the first time they use your CLI app, show usage tip, initialize something, etc.
Install
npm install first-run
Usage
// x.js
import isFirstRun from 'first-run';
console.log(isFirstRun({name: 'x'}));
$ node x.js
true
$ node x.js
false
API
isFirstRun(options)
clearFirstRun(options)
Clear the state.
options
Type: object
name
Type: string
The name used to identify it.
Usually, you would fetch the name
field from package.json.