diff --git a/src/client/voice/VoiceConnection.js b/src/client/voice/VoiceConnection.js index 439fea6ed..4b2add684 100644 --- a/src/client/voice/VoiceConnection.js +++ b/src/client/voice/VoiceConnection.js @@ -202,13 +202,9 @@ class VoiceConnection extends EventEmitter { /** * Options that can be passed to stream-playing methods: - * ```js - * { - * seek: 0, - * volume: 1 - * }; - * ``` * @typedef {Object} StreamOptions + * @property {number} [seek=0] The time to seek to + * @property {number} [volume=1] The volume to play at */ /** diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index 4a5738417..94e2eb939 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -205,15 +205,11 @@ class GuildChannel extends Channel { } /** - * Options given when creating a Guild Channel Invite: - * ```js - * { - * temporary: false, // whether the invite should kick users after 24hrs if they are not given a new role - * maxAge: 0, // the time in seconds the invite expires in - * maxUses: 0, // the maximum amount of uses for this invite - * } - * ``` + * Options given when creating a Guild Channel Invite * @typedef {Object} InviteOptions + * @property {boolean} [temporary=false] Whether the invite should kick users after 24hrs if they are not given a role + * @property {number} [maxAge=0] Time in seconds the invite expires in + * @property {maxUses} [maxUses=0] Maximum amount of uses for this invite */ /** diff --git a/src/structures/interface/TextBasedChannel.js b/src/structures/interface/TextBasedChannel.js index 4794be920..ec0e5358c 100644 --- a/src/structures/interface/TextBasedChannel.js +++ b/src/structures/interface/TextBasedChannel.js @@ -33,6 +33,21 @@ class TextBasedChannel { * }; * ``` * @typedef {Object} MessageOptions + * @property {boolean} [tts=false] Whether or not the message should be spoken aloud + * @property {string} [nonce=''] The nonce for the message + * @property {boolean} [disable_everyone=this.client.options.disable_everyone] Whether or not @everyone and @here + * should be replaced with plain-text + * @property {boolean|SplitObject} [split=false] Whether or not the message should be split into multiple messages if + * it exceeds the character limit. If an object is provided, these are the options for splitting the message. + */ + + /** + * Options for splitting a message + * @typedef {Object} SplitOptions + * @property {number} [maxLength=1950] Maximum character length per message piece + * @property {string} [char='\n'] Character to split the message with + * @property {string} [prepend=''] Text to prepend to each middle piece + * @property {string} [append=''] Text to append to each middle piece */ /** @@ -119,15 +134,11 @@ class TextBasedChannel { /** * The parameters to pass in when requesting previous messages from a channel. `around`, `before` and * `after` are mutually exclusive. All the parameters are optional. - * ```js - * { - * limit: 30, // the message limit, defaults to 50 - * before: '123', // gets messages before the given message ID - * after: '123', // gets messages after the given message ID - * around: '123', // gets messages around the given message ID - * } - * ``` * @typedef {Object} ChannelLogsQueryOptions + * @property {number} [limit=50] Number of messages to acquire + * @property {string} [before] ID of a message to get the messages that were posted before it + * @property {string} [after] ID of a message to get the messages that were posted after it + * @property {string} [around] ID of a message to get the messages that were posted around it */ /** @@ -255,12 +266,8 @@ class TextBasedChannel { /** * An object containing the same properties as CollectorOptions, but a few more: - * ```js - * { - * errors: [], // an array of stop/end reasons that cause the promise to reject. - * } - * ``` - * @typedef {Object} AwaitMessagesOptions + * @typedef {CollectorOptions} AwaitMessagesOptions + * @property {string[]} [errors] Stop/end reasons that cause the promise to reject */ /** @@ -332,13 +339,9 @@ class MessageCollector extends EventEmitter { /** * An object containing options used to configure a MessageCollector. All properties are optional. - * ```js - * { - * time: null, // time in milliseconds. If specified, the collector ends after this amount of time. - * max: null, // the maximum amount of messages to handle before ending. - * } - * ``` * @typedef {Object} CollectorOptions + * @property {number} [time] Duration for the collector in milliseconds + * @property {number} [max] Maximum number of messages to handle */ /**