Added JSDoc to notifications service's destroy

refs https://github.com/TryGhost/Team/issues/754

- Extra type intellisense is good!
This commit is contained in:
Naz 2021-06-24 16:34:29 +04:00
parent b5fb439ae7
commit 07f7a7a158

View File

@ -164,6 +164,15 @@ class Notifications {
return {allNotifications, notificationsToAdd};
}
/**
*
* @param {Object} options
* @param {string} options.notificationId - UUID of the notification
* @param {Object} options.user
* @param {string} options.user.id
*
* @returns {Promise<Object[]>}
*/
destroy({notificationId, user}) {
const allNotifications = this.fetchAllNotifications();