dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-10 02:02:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(ChannelPinsUpdate): clarify time param (#2823)

Browse source
This commit is contained in:
Ash 2018-09-05 08:33:44 -04:00 committed by SpaceEEC
parent e96a60361a
commit 9c2924a1b4
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/client/websocket/packets/handlers/ChannelPinsUpdate.js
View file

@ -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 * 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. * can be provided easily here - you need to manually check the pins yourself.
* <warn>The `time` parameter will be a Unix Epoch Date object when there are no pins left.</warn>
* @event Client#channelPinsUpdate * @event Client#channelPinsUpdate
* @param {DMChannel|GroupDMChannel|TextChannel} channel The channel that the pins update occured in * @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
*/ */