From 205954fa2747c65d9e42f2c50cd4eb9897078f2a Mon Sep 17 00:00:00 2001 From: Loren Segal Date: Tue, 25 Jul 2017 13:24:15 -0400 Subject: [PATCH] Mark certain Notification options as optional This change makes the `subtitle` and `actions` options optional to the Notification constructor, since they are only available on macOS. --- docs/api/notification.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/notification.md b/docs/api/notification.md index 64f094ff745..90361026682 100644 --- a/docs/api/notification.md +++ b/docs/api/notification.md @@ -31,13 +31,13 @@ Returns `Boolean` - Whether or not desktop notifications are supported on the cu * `options` Object * `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown - * `subtitle` String - A subtitle for the notification, which will be displayed below the title. _macOS_ + * `subtitle` String - (optional) A subtitle for the notification, which will be displayed below the title. _macOS_ * `body` String - The body text of the notification, which will be displayed below the title or subtitle * `silent` Boolean - (optional) Whether or not to emit an OS notification noise when showing the notification * `icon` [NativeImage](native-image.md) - (optional) An icon to use in the notification * `hasReply` Boolean - (optional) Whether or not to add an inline reply option to the notification. _macOS_ * `replyPlaceholder` String - (optional) The placeholder to write in the inline reply input field. _macOS_ - * `actions` [NotificationAction[]](structures/notification-action.md) - Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_ + * `actions` [NotificationAction[]](structures/notification-action.md) - (optional) Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation _macOS_ ### Instance Events