docs(WebhookClient): Make constructor a union (#8370)

Co-authored-by: muchnameless <12682826+muchnameless@users.noreply.github.com>
discordjs · Jul 27, 2022 · e9920a9 · e9920a9
1 parent 6d24805
commit e9920a9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 14 deletions.
diff --git a/packages/discord.js/src/client/WebhookClient.js b/packages/discord.js/src/client/WebhookClient.js
@@ -12,11 +12,21 @@ const { parseWebhookURL } = require('../util/Util');
  */
 class WebhookClient extends BaseClient {
   /**
-   * The data for the webhook client containing either an id and token or just a URL
-   * @typedef {Object} WebhookClientData
-   * @property {Snowflake} [id] The id of the webhook
-   * @property {string} [token] The token of the webhook
-   * @property {string} [url] The full URL for the webhook client
+   * Represents the credentials used for a webhook in the form of its id and token.
+   * @typedef {Object} WebhookClientDataIdWithToken
+   * @property {Snowflake} id The webhook's id
+   * @property {string} token The webhook's token
+   */
+
+  /**
+   * Represents the credentials used for a webhook in the form of a URL.
+   * @typedef {Object} WebhookClientDataURL
+   * @property {string} url The full URL for the webhook
+   */
+
+  /**
+   * Represents the credentials used for a webhook.
+   * @typedef {WebhookClientDataIdWithToken|WebhookClientDataURL} WebhookClientData
    */
 
   /**

diff --git a/packages/discord.js/src/util/Util.js b/packages/discord.js/src/util/Util.js
@@ -520,16 +520,9 @@ function lazy(cb) {
 }
 
 /**
- * Represents the credentials used for a given webhook
- * @typedef {Object} WebhookCredentials
- * @property {string} id The webhook's id
- * @property {string} token The webhook's token
- */
-
-/**
- * Parses a webhook URL for the id and token
+ * Parses a webhook URL for the id and token.
  * @param {string} url The URL to parse
- * @returns {?WebhookCredentials} Null if the URL is invalid, otherwise the id and the token
+ * @returns {?WebhookClientDataIdWithToken} `null` if the URL is invalid, otherwise the id and the token
  */
 function parseWebhookURL(url) {
   const matches = url.match(