display-notification

3.0.0 • Public • Published

display-notification

Display a notification (macOS 10.9+)

Install

$ npm install display-notification

Usage

import displayNotification from 'display-notification';

await displayNotification({
	title: 'Unicorns',
	subtitle: 'Rainbows',
	text: 'Cake',
	sound: 'Bottle'
});

API

displayNotification(options)

Returns a promise that resolves when the notification is shown.

options

Specify at least a title or text.

title

Type: string

Title of the notification.

subtitle

Type: string

Subtitle of the notification.

text

Type: string

Content of the notification.

sound

Type: string
Values: Basso Blow Bottle Frog Funk Glass Hero Morse Ping Pop Purr Sosumi Submarine Tink

Name of the sound located in ~/Library/Sounds or /System/Library/Sounds:

Package Sidebar

Install

npm i display-notification

Weekly Downloads

206,468

Version

3.0.0

License

MIT

Unpacked Size

3.43 kB

Total Files

4

Last publish

Collaborators

  • sindresorhus