@discordjs/core 2.1.0-dev.1731413115-e2df0e0db → 2.1.0-dev.1731672302-3669d5e11

package/dist/http-only.d.mts

@@ -258,9 +258,17 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#get-reactions}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to get the reactions for
-     * @param emoji - The emoji to get the reactions for
+     * @param emoji - The emoji to get the reactions for. URL encoding happens internally
      * @param query - The query options for fetching the reactions
      * @param options - The options for fetching the message reactions
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.getMessageReactions('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.getMessageReactions('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     getMessageReactions(channelId: Snowflake, messageId: Snowflake, emoji: string, query?: RESTGetAPIChannelMessageReactionUsersQuery, { signal }?: Pick<RequestData, 'signal'>): Promise<RESTGetAPIChannelMessageReactionUsersResult>;
     /**
@@ -269,8 +277,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-own-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reaction for
-     * @param emoji - The emoji to delete the reaction for
+     * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
      * @param options - The options for deleting the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     deleteOwnMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -279,9 +295,17 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-user-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reaction for
-     * @param emoji - The emoji to delete the reaction for
+     * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
      * @param userId - The id of the user to delete the reaction for
      * @param options - The options for deleting the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', '👍', '1234567890');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890', '1234567890');
+     * ```
      */
     deleteUserMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, userId: Snowflake, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -299,8 +323,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-all-reactions-for-emoji}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reactions for
-     * @param emoji - The emoji to delete the reactions for
+     * @param emoji - The emoji to delete the reactions for. URL encoding happens internally
      * @param options - The options for deleting the reactions
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     deleteAllMessageReactionsForEmoji(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -309,8 +341,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#create-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to add the reaction to
-     * @param emoji - The emoji to add the reaction with
+     * @param emoji - The emoji to add the reaction with. URL encoding happens internally
      * @param options - The options for adding the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.addMessageReaction('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.addMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     addMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**

package/dist/http-only.d.ts

@@ -258,9 +258,17 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#get-reactions}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to get the reactions for
-     * @param emoji - The emoji to get the reactions for
+     * @param emoji - The emoji to get the reactions for. URL encoding happens internally
      * @param query - The query options for fetching the reactions
      * @param options - The options for fetching the message reactions
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.getMessageReactions('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.getMessageReactions('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     getMessageReactions(channelId: Snowflake, messageId: Snowflake, emoji: string, query?: RESTGetAPIChannelMessageReactionUsersQuery, { signal }?: Pick<RequestData, 'signal'>): Promise<RESTGetAPIChannelMessageReactionUsersResult>;
     /**
@@ -269,8 +277,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-own-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reaction for
-     * @param emoji - The emoji to delete the reaction for
+     * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
      * @param options - The options for deleting the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     deleteOwnMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -279,9 +295,17 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-user-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reaction for
-     * @param emoji - The emoji to delete the reaction for
+     * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
      * @param userId - The id of the user to delete the reaction for
      * @param options - The options for deleting the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', '👍', '1234567890');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890', '1234567890');
+     * ```
      */
     deleteUserMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, userId: Snowflake, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -299,8 +323,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#delete-all-reactions-for-emoji}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to delete the reactions for
-     * @param emoji - The emoji to delete the reactions for
+     * @param emoji - The emoji to delete the reactions for. URL encoding happens internally
      * @param options - The options for deleting the reactions
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     deleteAllMessageReactionsForEmoji(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**
@@ -309,8 +341,16 @@ declare class ChannelsAPI {
      * @see {@link https://discord.com/developers/docs/resources/message#create-reaction}
      * @param channelId - The id of the channel the message is in
      * @param messageId - The id of the message to add the reaction to
-     * @param emoji - The emoji to add the reaction with
+     * @param emoji - The emoji to add the reaction with. URL encoding happens internally
      * @param options - The options for adding the reaction
+     * @example
+     * ```ts
+     * // Unicode.
+     * await api.channels.addMessageReaction('1234567890', '1234567890', '👍');
+     *
+     * // Custom emoji.
+     * await api.channels.addMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+     * ```
      */
     addMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, { signal }?: Pick<RequestData, 'signal'>): Promise<void>;
     /**

package/dist/http-only.js

@@ -416,9 +416,17 @@ var ChannelsAPI = class {
    * @see {@link https://discord.com/developers/docs/resources/message#get-reactions}
    * @param channelId - The id of the channel the message is in
    * @param messageId - The id of the message to get the reactions for
-   * @param emoji - The emoji to get the reactions for
+   * @param emoji - The emoji to get the reactions for. URL encoding happens internally
    * @param query - The query options for fetching the reactions
    * @param options - The options for fetching the message reactions
+   * @example
+   * ```ts
+   * // Unicode.
+   * await api.channels.getMessageReactions('1234567890', '1234567890', '👍');
+   *
+   * // Custom emoji.
+   * await api.channels.getMessageReactions('1234567890', '1234567890', 'emoji_name:1234567890');
+   * ```
    */
   async getMessageReactions(channelId, messageId, emoji, query = {}, { signal } = {}) {
     return this.rest.get(import_v103.Routes.channelMessageReaction(channelId, messageId, encodeURIComponent(emoji)), {
@@ -432,8 +440,16 @@ var ChannelsAPI = class {
    * @see {@link https://discord.com/developers/docs/resources/message#delete-own-reaction}
    * @param channelId - The id of the channel the message is in
    * @param messageId - The id of the message to delete the reaction for
-   * @param emoji - The emoji to delete the reaction for
+   * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
    * @param options - The options for deleting the reaction
+   * @example
+   * ```ts
+   * // Unicode.
+   * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', '👍');
+   *
+   * // Custom emoji.
+   * await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+   * ```
    */
   async deleteOwnMessageReaction(channelId, messageId, emoji, { signal } = {}) {
     await this.rest.delete(import_v103.Routes.channelMessageOwnReaction(channelId, messageId, encodeURIComponent(emoji)), {
@@ -446,9 +462,17 @@ var ChannelsAPI = class {
    * @see {@link https://discord.com/developers/docs/resources/message#delete-user-reaction}
    * @param channelId - The id of the channel the message is in
    * @param messageId - The id of the message to delete the reaction for
-   * @param emoji - The emoji to delete the reaction for
+   * @param emoji - The emoji to delete the reaction for. URL encoding happens internally
    * @param userId - The id of the user to delete the reaction for
    * @param options - The options for deleting the reaction
+   * @example
+   * ```ts
+   * // Unicode.
+   * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', '👍', '1234567890');
+   *
+   * // Custom emoji.
+   * await api.channels.deleteUserMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890', '1234567890');
+   * ```
    */
   async deleteUserMessageReaction(channelId, messageId, emoji, userId, { signal } = {}) {
     await this.rest.delete(import_v103.Routes.channelMessageUserReaction(channelId, messageId, encodeURIComponent(emoji), userId), {
@@ -472,8 +496,16 @@ var ChannelsAPI = class {
    * @see {@link https://discord.com/developers/docs/resources/message#delete-all-reactions-for-emoji}
    * @param channelId - The id of the channel the message is in
    * @param messageId - The id of the message to delete the reactions for
-   * @param emoji - The emoji to delete the reactions for
+   * @param emoji - The emoji to delete the reactions for. URL encoding happens internally
    * @param options - The options for deleting the reactions
+   * @example
+   * ```ts
+   * // Unicode.
+   * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', '👍');
+   *
+   * // Custom emoji.
+   * await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', 'emoji_name:1234567890');
+   * ```
    */
   async deleteAllMessageReactionsForEmoji(channelId, messageId, emoji, { signal } = {}) {
     await this.rest.delete(import_v103.Routes.channelMessageReaction(channelId, messageId, encodeURIComponent(emoji)), { signal });
@@ -484,8 +516,16 @@ var ChannelsAPI = class {
    * @see {@link https://discord.com/developers/docs/resources/message#create-reaction}
    * @param channelId - The id of the channel the message is in
    * @param messageId - The id of the message to add the reaction to
-   * @param emoji - The emoji to add the reaction with
+   * @param emoji - The emoji to add the reaction with. URL encoding happens internally
    * @param options - The options for adding the reaction
+   * @example
+   * ```ts
+   * // Unicode.
+   * await api.channels.addMessageReaction('1234567890', '1234567890', '👍');
+   *
+   * // Custom emoji.
+   * await api.channels.addMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');
+   * ```
    */
   async addMessageReaction(channelId, messageId, emoji, { signal } = {}) {
     await this.rest.put(import_v103.Routes.channelMessageOwnReaction(channelId, messageId, encodeURIComponent(emoji)), { signal });
@@ -3010,7 +3050,7 @@ __name(withFiles, "withFiles");
 
 // src/http-only/index.ts
 __reExport(http_only_exports, require("discord-api-types/v10"), module.exports);
-var version = "2.1.0-dev.1731413115-e2df0e0db";
+var version = "2.1.0-dev.1731672302-3669d5e11";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   API,