1. module update-notifier
   1. function update-notifier (options)
   2. function update-notifier.UpdateNotifier (options)
   3. function update-notifier.index (options)
2. module update-notifier.index
   1. function update-notifier.index (options)
   2. function update-notifier.index.UpdateNotifier (options)

module update-notifier

function update-notifier (options)

• description and source-code

  options => {
  	const updateNotifier = new UpdateNotifier(options);
  	updateNotifier.check();
  	return updateNotifier;
  }

• example usage

  n/a

function update-notifier.UpdateNotifier (options)

• description and source-code

  class UpdateNotifier {
  	constructor(options) {
  		this.options = options = options || {};
  		options.pkg = options.pkg || {};
  
  		// Reduce pkg to the essential keys. with fallback to deprecated options
  		// TODO: Remove deprecated options at some point far into the future
  		options.pkg = {
  			name: options.pkg.name || options.packageName,
  			version: options.pkg.version || options.packageVersion
  		};
  
  		if (!options.pkg.name || !options.pkg.version) {
  			throw new Error('pkg.name and pkg.version required');
  		}
  
  		this.packageName = options.pkg.name;
  		this.packageVersion = options.pkg.version;
  		this.updateCheckInterval = typeof options.updateCheckInterval === 'number' ? options.updateCheckInterval : ONE_DAY;
  		this.hasCallback = typeof options.callback === 'function';
  		this.callback = options.callback || (() => {});
  
  		if (!this.hasCallback) {
  			try {
  				const ConfigStore = configstore();
  				this.config = new ConfigStore(`update-notifier-${this.packageName}`, {
  					optOut: false,
  					// Init with the current time so the first check is only
  					// after the set interval, so not to bother users right away
  					lastUpdateCheck: Date.now()
  				});
  			} catch (err) {
  				// Expecting error code EACCES or EPERM
  				const msg =
  					chalk().yellow(format(' %s update check failed ', options.pkg.name)) +
  					format('\n Try running with %s or get access ', chalk().cyan('sudo')) +
  					'\n to the local update config store via \n' +
  					chalk().cyan(format(' sudo chown -R $USER:$(id -gn $USER) %s ', xdgBasedir().config));
  
  				process.on('exit', () => {
  					console.error('\n' + boxen()(msg, {align: 'center'}));
  				});
  			}
  		}
  	}
  	check() {
  		if (this.hasCallback) {
  			this.checkNpm()
  				.then(update => this.callback(null, update))
  				.catch(err => this.callback(err));
  			return;
  		}
  
  		if (
  			!this.config ||
  			this.config.get('optOut') ||
  			'NO_UPDATE_NOTIFIER' in process.env ||
  			process.argv.indexOf('--no-update-notifier') !== -1
  		) {
  			return;
  		}
  
  		this.update = this.config.get('update');
  
  		if (this.update) {
  			this.config.delete('update');
  		}
  
  		// Only check for updates on a set interval
  		if (Date.now() - this.config.get('lastUpdateCheck') < this.updateCheckInterval) {
  			return;
  		}
  
  		// Spawn a detached process, passing the options as an environment property
  		spawn(process.execPath, [path.join(__dirname, 'check.js'), JSON.stringify(this.options)], {
  			detached: true,
  			stdio: 'ignore'
  		}).unref();
  	}
  	checkNpm() {
  		return latestVersion()(this.packageName).then(latestVersion => {
  			return {
  				latest: latestVersion,
  				current: this.packageVersion,
  				type: semverDiff()(this.packageVersion, latestVersion) || 'latest',
  				name: this.packageName
  			};
  		});
  	}
  	notify(opts) {
  		if (!process.stdout.isTTY || isNpm() || !this.update) {
  			return this;
  		}
  
  		opts = Object.assign({isGlobal: true}, opts);
  
  		opts.message = opts.message || 'Update available ' + chalk().dim(this.update.current) + chalk().reset(' → ') +
  			chalk().green(this.update.latest) + ' \nRun ' + chalk().cyan('npm i ' + (opts.isGlobal ? '-g ' : '') + this.packageName) + '
  to update';
  
  		opts.boxenOpts = opts.boxenOpts || {
  			padding: 1,
  			margin: 1,
  			align: 'center',
  			borderColor: 'yellow',
  			borderStyle: 'round'
  		};
  
  		const message = '\n' + boxen()(opts.message, opts.boxenOpts);
  
  		if (opts.defer === false) {
  			console.error(message);
  		} else {
  			process.on('exit', () => {
  				console.error(message);
  			});
  
  			process.on('SIGINT', () => {
  				console.error('');
  				process.exit();
  			});
  		}
  
  		return this;
  	}
  }

• example usage

  ...
  
  /* eslint-disable unicorn/no-process-exit */
  'use strict';
  let updateNotifier = require('.');
  
  const options = JSON.parse(process.argv[2]);
  
  updateNotifier = new updateNotifier.UpdateNotifier(options);
  
  updateNotifier.checkNpm().then(update => {
  	// Only update the last update check time on success
  	updateNotifier.config.set('lastUpdateCheck', Date.now());
  
  	if (update.type && update.type !== 'latest') {
  		updateNotifier.config.set('update', update);
  ...

function update-notifier.index (options)

• description and source-code

  options => {
  	const updateNotifier = new UpdateNotifier(options);
  	updateNotifier.check();
  	return updateNotifier;
  }

• example usage

  n/a

module update-notifier.index

function update-notifier.index (options)

• description and source-code

  options => {
  	const updateNotifier = new UpdateNotifier(options);
  	updateNotifier.check();
  	return updateNotifier;
  }

• example usage

  n/a

function update-notifier.index.UpdateNotifier (options)

• description and source-code

  class UpdateNotifier {
  	constructor(options) {
  		this.options = options = options || {};
  		options.pkg = options.pkg || {};
  
  		// Reduce pkg to the essential keys. with fallback to deprecated options
  		// TODO: Remove deprecated options at some point far into the future
  		options.pkg = {
  			name: options.pkg.name || options.packageName,
  			version: options.pkg.version || options.packageVersion
  		};
  
  		if (!options.pkg.name || !options.pkg.version) {
  			throw new Error('pkg.name and pkg.version required');
  		}
  
  		this.packageName = options.pkg.name;
  		this.packageVersion = options.pkg.version;
  		this.updateCheckInterval = typeof options.updateCheckInterval === 'number' ? options.updateCheckInterval : ONE_DAY;
  		this.hasCallback = typeof options.callback === 'function';
  		this.callback = options.callback || (() => {});
  
  		if (!this.hasCallback) {
  			try {
  				const ConfigStore = configstore();
  				this.config = new ConfigStore(`update-notifier-${this.packageName}`, {
  					optOut: false,
  					// Init with the current time so the first check is only
  					// after the set interval, so not to bother users right away
  					lastUpdateCheck: Date.now()
  				});
  			} catch (err) {
  				// Expecting error code EACCES or EPERM
  				const msg =
  					chalk().yellow(format(' %s update check failed ', options.pkg.name)) +
  					format('\n Try running with %s or get access ', chalk().cyan('sudo')) +
  					'\n to the local update config store via \n' +
  					chalk().cyan(format(' sudo chown -R $USER:$(id -gn $USER) %s ', xdgBasedir().config));
  
  				process.on('exit', () => {
  					console.error('\n' + boxen()(msg, {align: 'center'}));
  				});
  			}
  		}
  	}
  	check() {
  		if (this.hasCallback) {
  			this.checkNpm()
  				.then(update => this.callback(null, update))
  				.catch(err => this.callback(err));
  			return;
  		}
  
  		if (
  			!this.config ||
  			this.config.get('optOut') ||
  			'NO_UPDATE_NOTIFIER' in process.env ||
  			process.argv.indexOf('--no-update-notifier') !== -1
  		) {
  			return;
  		}
  
  		this.update = this.config.get('update');
  
  		if (this.update) {
  			this.config.delete('update');
  		}
  
  		// Only check for updates on a set interval
  		if (Date.now() - this.config.get('lastUpdateCheck') < this.updateCheckInterval) {
  			return;
  		}
  
  		// Spawn a detached process, passing the options as an environment property
  		spawn(process.execPath, [path.join(__dirname, 'check.js'), JSON.stringify(this.options)], {
  			detached: true,
  			stdio: 'ignore'
  		}).unref();
  	}
  	checkNpm() {
  		return latestVersion()(this.packageName).then(latestVersion => {
  			return {
  				latest: latestVersion,
  				current: this.packageVersion,
  				type: semverDiff()(this.packageVersion, latestVersion) || 'latest',
  				name: this.packageName
  			};
  		});
  	}
  	notify(opts) {
  		if (!process.stdout.isTTY || isNpm() || !this.update) {
  			return this;
  		}
  
  		opts = Object.assign({isGlobal: true}, opts);
  
  		opts.message = opts.message || 'Update available ' + chalk().dim(this.update.current) + chalk().reset(' → ') +
  			chalk().green(this.update.latest) + ' \nRun ' + chalk().cyan('npm i ' + (opts.isGlobal ? '-g ' : '') + this.packageName) + '
  to update';
  
  		opts.boxenOpts = opts.boxenOpts || {
  			padding: 1,
  			margin: 1,
  			align: 'center',
  			borderColor: 'yellow',
  			borderStyle: 'round'
  		};
  
  		const message = '\n' + boxen()(opts.message, opts.boxenOpts);
  
  		if (opts.defer === false) {
  			console.error(message);
  		} else {
  			process.on('exit', () => {
  				console.error(message);
  			});
  
  			process.on('SIGINT', () => {
  				console.error('');
  				process.exit();
  			});
  		}
  
  		return this;
  	}
  }

• example usage

  ...
  
  /* eslint-disable unicorn/no-process-exit */
  'use strict';
  let updateNotifier = require('.');
  
  const options = JSON.parse(process.argv[2]);
  
  updateNotifier = new updateNotifier.UpdateNotifier(options);
  
  updateNotifier.checkNpm().then(update => {
  	// Only update the last update check time on success
  	updateNotifier.config.set('lastUpdateCheck', Date.now());
  
  	if (update.type && update.type !== 'latest') {
  		updateNotifier.config.set('update', update);
  ...