@types/update-notifier

constructor

constructor(settings: Settings);

property config

readonly config?: any;

property update

readonly update?: UpdateInfo;

method check

check: () => void;

method fetchInfo

fetchInfo: () => UpdateInfo | Promise<UpdateInfo>;

• Check update information

method notify

notify: (customMessage?: NotifyOptions) => void;

• Convenience method to display a notification message

property boxenOptions

boxenOptions?: BoxenOptions | undefined;

• Options object that will be passed to boxen See https://github.com/sindresorhus/boxen/blob/master/index.d.ts

property defer

defer?: boolean | undefined;

• Defer showing the notification to after the process has exited

property isGlobal

isGlobal?: boolean | undefined;

• Include the -g argument in the default message's npm i recommendation

property message

message?: string | undefined;

• Message that will be shown when an update is available

property name

name: string;

property version

version: string;

property distTag

distTag?: string | undefined;

• Which dist-tag to use to find the latest version 'latest'

property packageName

packageName?: string | undefined;

• Deprecated

  use pkg.name

property packageVersion

packageVersion?: string | undefined;

• Deprecated

  use pkg.version

property pkg

pkg?: Package | undefined;

property shouldNotifyInNpmScript

shouldNotifyInNpmScript?: boolean | undefined;

• Allows notification to be shown when running as an npm script

property updateCheckInterval

updateCheckInterval?: number | undefined;

• How often to check for updates

property current

readonly current: string;

• Current version

property latest

readonly latest: string;

• Latest version

property name

name: string;

• Package name

property type

readonly type: 'latest' | 'major' | 'minor' | 'patch' | 'prerelease' | 'build';

• Type of current update