3.0.0 • Published 5 years ago

electron-first-run v3.0.0

Weekly downloads
301
License
MIT
Repository
github
Last release
5 years ago

electron-first-run

Build Status: Linux and macOS Build status: Windows

Check if it's the first time an Electron App runs.

This pacakge it's based on first-run by @sindresorhus, keeping the API as a drop in replacement for Electron.

Install

$ npm install --save electron-first-run
or
$ yarn add --save electron-first-run

Usage

// main process
const firstRun = require('electron-first-run');

const isFirstRun = firstRun()
console.log(isFirstRun);

API

firstRun(options)

options.name

Type: string Default: electron-app-first-run

Name of the storage file (without extension).

This is useful if you want multiple storage files for your app. Or if you're making a reusable Electron module that persists some data, in which case you should not use the default name.

firstRun.clear()

Clear the state.

License

MIT © Joseph Cohen