Skip to content

Commit

Permalink
docs(WebhookClient): Document working options (#8375)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jiralite committed Jul 27, 2022
1 parent 7fd9ed8 commit ba6797e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion packages/discord.js/src/client/WebhookClient.js
Expand Up @@ -29,9 +29,16 @@ class WebhookClient extends BaseClient {
* @typedef {WebhookClientDataIdWithToken|WebhookClientDataURL} WebhookClientData
*/

/**
* Options for a webhook client.
* @typedef {Object} WebhookClientOptions
* @property {MessageMentionOptions} [allowedMentions] Default value for {@link WebhookMessageOptions#allowedMentions}
* @property {RESTOptions} [rest] Options for the REST manager
*/

/**
* @param {WebhookClientData} data The data of the webhook
* @param {ClientOptions} [options] Options for the client
* @param {WebhookClientOptions} [options] Options for the webhook client
*/
constructor(data, options) {
super(options);
Expand All @@ -51,6 +58,12 @@ class WebhookClient extends BaseClient {
Object.defineProperty(this, 'token', { value: token, writable: true, configurable: true });
}

/**
* The options the webhook client was instantiated with.
* @type {WebhookClientOptions}
* @name WebhookClient#options
*/

// These are here only for documentation purposes - they are implemented by Webhook
/* eslint-disable no-empty-function, valid-jsdoc */
/**
Expand Down

1 comment on commit ba6797e

@vercel
Copy link

@vercel vercel bot commented on ba6797e Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.