Improve notification.js

Added:
- Block comment
- Support for additional node-notifier properties.
This commit is contained in:
Chauncey McAskill
2021-09-16 23:46:20 -04:00
parent 6e50bc202d
commit 84286fef66

View File

@@ -1,9 +1,29 @@
import notifier from 'node-notifier'; import notifier from 'node-notifier';
export default function notification({ title, message }) { /**
notifier.notify({ * Sends a cross-platform native notification.
title, *
message, * Wraps around node-notifier to assign default values.
icon: 'https://user-images.githubusercontent.com/4596862/54868065-c2aea200-4d5e-11e9-9ce3-e0013c15f48c.png' *
}); * @param {string|object} options - The notification options or a message.
* @param {string} options.title - The notification title.
* @param {string} options.message - The notification message.
* @param {string} options.icon - The notification icon.
*/
export default function notification(options) {
if (typeof options === 'string') {
options = {
message: options
};
} else if (!options.title && !options.message) {
throw new TypeError(
'Notification expects at least a \'message\' parameter'
);
}
if (typeof options.icon === 'undefined') {
options.icon = 'https://user-images.githubusercontent.com/4596862/54868065-c2aea200-4d5e-11e9-9ce3-e0013c15f48c.png';
}
notifier.notify(options);
}; };