From 9c2924a1b49d2621abd97f3354fe2a64eb134141 Mon Sep 17 00:00:00 2001 From: Ash <28841569+Asshley@users.noreply.github.com> Date: Wed, 5 Sep 2018 08:33:44 -0400 Subject: [PATCH] docs(ChannelPinsUpdate): clarify time param (#2823) --- src/client/websocket/packets/handlers/ChannelPinsUpdate.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/client/websocket/packets/handlers/ChannelPinsUpdate.js b/src/client/websocket/packets/handlers/ChannelPinsUpdate.js index ea6c8f31d..702be2253 100644 --- a/src/client/websocket/packets/handlers/ChannelPinsUpdate.js +++ b/src/client/websocket/packets/handlers/ChannelPinsUpdate.js @@ -30,7 +30,8 @@ module.exports = ChannelPinsUpdate; /** * Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information * can be provided easily here - you need to manually check the pins yourself. + * The `time` parameter will be a Unix Epoch Date object when there are no pins left. * @event Client#channelPinsUpdate * @param {DMChannel|GroupDMChannel|TextChannel} channel The channel that the pins update occured in - * @param {Date} time The time of the pins update + * @param {Date} time The time when the last pinned message was pinned */