@discordjs/rest 0.6.0-dev.1656547798-27d8deb → 0.6.0-dev.1656677085-741b3c8

package/dist/index.d.ts

@@ -38,11 +38,13 @@ interface RequestData {
     appendToFormData?: boolean;
     /**
      * If this request needs the `Authorization` header
+     *
      * @default true
      */
     auth?: boolean;
     /**
      * The authorization prefix to use for this request, useful if you use this with bearer tokens
+     *
      * @default 'Bot'
      */
     authPrefix?: 'Bot' | 'Bearer';
@@ -78,6 +80,7 @@ interface RequestData {
     reason?: string;
     /**
      * If this request should be versioned
+     *
      * @default true
      */
     versioned?: boolean;
@@ -174,30 +177,37 @@ declare class RequestManager extends EventEmitter {
     private setupSweepers;
     /**
      * Sets the default agent to use for requests performed by this manager
-     * @param agent The agent to use
+     *
+     * @param agent - The agent to use
      */
     setAgent(agent: Dispatcher): this;
     /**
      * Sets the authorization token that should be used for requests
-     * @param token The authorization token to use
+     *
+     * @param token - The authorization token to use
      */
     setToken(token: string): this;
     /**
      * Queues a request to be sent
-     * @param request All the information needed to make a request
+     *
+     * @param request - All the information needed to make a request
+     *
      * @returns The response from the api request
      */
     queueRequest(request: InternalRequest): Promise<Dispatcher.ResponseData>;
     /**
      * Creates a new rate limit handler from a hash, based on the hash and the major parameter
-     * @param hash The hash for the route
-     * @param majorParameter The major parameter for this handler
+     *
+     * @param hash - The hash for the route
+     * @param majorParameter - The major parameter for this handler
+     *
      * @private
      */
     private createHandler;
     /**
      * Formats the request data to a usable format for fetch
-     * @param request The request data
+     *
+     * @param request - The request data
      */
     private resolveRequest;
     /**
@@ -210,8 +220,10 @@ declare class RequestManager extends EventEmitter {
     clearHandlerSweeper(): void;
     /**
      * Generates route data for an endpoint:method
-     * @param endpoint The raw endpoint to generalize
-     * @param method The HTTP method this endpoint is called without
+     *
+     * @param endpoint - The raw endpoint to generalize
+     * @param method - The HTTP method this endpoint is called without
+     *
      * @private
      */
     private static generateRouteData;
@@ -233,32 +245,38 @@ interface RESTOptions {
     /**
      * The authorization prefix to use for requests, useful if you want to use
      * bearer tokens
+     *
      * @default 'Bot'
      */
     authPrefix: 'Bot' | 'Bearer';
     /**
      * The cdn path
+     *
      * @default 'https://cdn.discordapp.com'
      */
     cdn: string;
     /**
      * Additional headers to send for all API requests
+     *
      * @default {}
      */
     headers: Record<string, string>;
     /**
      * The number of invalid REST requests (those that return 401, 403, or 429) in a 10 minute window between emitted warnings (0 for no warnings).
      * That is, if set to 500, warnings will be emitted at invalid request number 500, 1000, 1500, and so on.
+     *
      * @default 0
      */
     invalidRequestWarningInterval: number;
     /**
      * How many requests to allow sending per second (Infinity for unlimited, 50 for the standard global limit used by Discord)
+     *
      * @default 50
      */
     globalRequestsPerSecond: number;
     /**
      * The extra offset to add to rate limits in milliseconds
+     *
      * @default 50
      */
     offset: number;
@@ -267,42 +285,50 @@ interface RESTOptions {
      * When an array of strings, each element is treated as a prefix for the request route
      * (e.g. `/channels` to match any route starting with `/channels` such as `/channels/:id/messages`)
      * for which to throw {@link RateLimitError}s. All other request routes will be queued normally
+     *
      * @default null
      */
     rejectOnRateLimit: string[] | RateLimitQueueFilter | null;
     /**
      * The number of retries for errors with the 500 code, or errors
      * that timeout
+     *
      * @default 3
      */
     retries: number;
     /**
      * The time to wait in milliseconds before a request is aborted
+     *
      * @default 15_000
      */
     timeout: number;
     /**
      * Extra information to add to the user agent
+     *
      * @default `Node.js ${process.version}`
      */
     userAgentAppendix: string;
     /**
      * The version of the API to use
+     *
      * @default '10'
      */
     version: string;
     /**
      * The amount of time in milliseconds that passes between each hash sweep. (defaults to 4h)
+     *
      * @default 14_400_000
      */
     hashSweepInterval: number;
     /**
      * The maximum amount of time a hash can exist in milliseconds without being hit with a request (defaults to 24h)
+     *
      * @default 86_400_000
      */
     hashLifetime: number;
     /**
      * The amount of time in milliseconds that passes between each hash sweep. (defaults to 1h)
+     *
      * @default 3_600_000
      */
     handlerSweepInterval: number;
@@ -415,52 +441,61 @@ declare class REST extends EventEmitter {
     getAgent(): Dispatcher | null;
     /**
      * Sets the default agent to use for requests performed by this instance
-     * @param agent Sets the agent to use
+     *
+     * @param agent - Sets the agent to use
      */
     setAgent(agent: Dispatcher): this;
     /**
      * Sets the authorization token that should be used for requests
-     * @param token The authorization token to use
+     *
+     * @param token - The authorization token to use
      */
     setToken(token: string): this;
     /**
      * Runs a get request from the api
-     * @param fullRoute The full route to query
-     * @param options Optional request options
+     *
+     * @param fullRoute - The full route to query
+     * @param options - Optional request options
      */
     get(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
     /**
      * Runs a delete request from the api
-     * @param fullRoute The full route to query
-     * @param options Optional request options
+     *
+     * @param fullRoute - The full route to query
+     * @param options - Optional request options
      */
     delete(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
     /**
      * Runs a post request from the api
-     * @param fullRoute The full route to query
-     * @param options Optional request options
+     *
+     * @param fullRoute - The full route to query
+     * @param options - Optional request options
      */
     post(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
     /**
      * Runs a put request from the api
-     * @param fullRoute The full route to query
-     * @param options Optional request options
+     *
+     * @param fullRoute - The full route to query
+     * @param options - Optional request options
      */
     put(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
     /**
      * Runs a patch request from the api
-     * @param fullRoute The full route to query
-     * @param options Optional request options
+     *
+     * @param fullRoute - The full route to query
+     * @param options - Optional request options
      */
     patch(fullRoute: RouteLike, options?: RequestData): Promise<unknown>;
     /**
      * Runs a request from the api
-     * @param options Request options
+     *
+     * @param options - Request options
      */
     request(options: InternalRequest): Promise<unknown>;
     /**
      * Runs a request from the API, yielding the raw Response object
-     * @param options Request options
+     *
+     * @param options - Request options
      */
     raw(options: InternalRequest): Promise<Dispatcher.ResponseData>;
 }
@@ -491,6 +526,7 @@ declare type ImageSize = typeof ALLOWED_SIZES[number];
 interface BaseImageURLOptions {
     /**
      * The extension to use for the image URL
+     *
      * @default 'webp'
      */
     extension?: ImageExtension;
@@ -514,6 +550,7 @@ interface ImageURLOptions extends BaseImageURLOptions {
 interface MakeURLOptions {
     /**
      * The extension to use for the image URL
+     *
      * @default 'webp'
      */
     extension?: string | undefined;
@@ -534,131 +571,149 @@ declare class CDN {
     constructor(base?: string);
     /**
      * Generates an app asset URL for a client's asset.
-     * @param clientId The client id that has the asset
-     * @param assetHash The hash provided by Discord for this asset
-     * @param options Optional options for the asset
+     *
+     * @param clientId - The client id that has the asset
+     * @param assetHash - The hash provided by Discord for this asset
+     * @param options - Optional options for the asset
      */
     appAsset(clientId: string, assetHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates an app icon URL for a client's icon.
-     * @param clientId The client id that has the icon
-     * @param iconHash The hash provided by Discord for this icon
-     * @param options Optional options for the icon
+     *
+     * @param clientId - The client id that has the icon
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
      */
     appIcon(clientId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates an avatar URL, e.g. for a user or a webhook.
-     * @param id The id that has the icon
-     * @param avatarHash The hash provided by Discord for this avatar
-     * @param options Optional options for the avatar
+     *
+     * @param id - The id that has the icon
+     * @param avatarHash - The hash provided by Discord for this avatar
+     * @param options - Optional options for the avatar
      */
     avatar(id: string, avatarHash: string, options?: Readonly<ImageURLOptions>): string;
     /**
      * Generates a banner URL, e.g. for a user or a guild.
-     * @param id The id that has the banner splash
-     * @param bannerHash The hash provided by Discord for this banner
-     * @param options Optional options for the banner
+     *
+     * @param id - The id that has the banner splash
+     * @param bannerHash - The hash provided by Discord for this banner
+     * @param options - Optional options for the banner
      */
     banner(id: string, bannerHash: string, options?: Readonly<ImageURLOptions>): string;
     /**
      * Generates an icon URL for a channel, e.g. a group DM.
-     * @param channelId The channel id that has the icon
-     * @param iconHash The hash provided by Discord for this channel
-     * @param options Optional options for the icon
+     *
+     * @param channelId - The channel id that has the icon
+     * @param iconHash - The hash provided by Discord for this channel
+     * @param options - Optional options for the icon
      */
     channelIcon(channelId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates the default avatar URL for a discriminator.
-     * @param discriminator The discriminator modulo 5
+     *
+     * @param discriminator - The discriminator modulo 5
      */
     defaultAvatar(discriminator: number): string;
     /**
      * Generates a discovery splash URL for a guild's discovery splash.
-     * @param guildId The guild id that has the discovery splash
-     * @param splashHash The hash provided by Discord for this splash
-     * @param options Optional options for the splash
+     *
+     * @param guildId - The guild id that has the discovery splash
+     * @param splashHash - The hash provided by Discord for this splash
+     * @param options - Optional options for the splash
      */
     discoverySplash(guildId: string, splashHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates an emoji's URL for an emoji.
-     * @param emojiId The emoji id
-     * @param extension The extension of the emoji
+     *
+     * @param emojiId - The emoji id
+     * @param extension - The extension of the emoji
      */
     emoji(emojiId: string, extension?: ImageExtension): string;
     /**
      * Generates a guild member avatar URL.
-     * @param guildId The id of the guild
-     * @param userId The id of the user
-     * @param avatarHash The hash provided by Discord for this avatar
-     * @param options Optional options for the avatar
+     *
+     * @param guildId - The id of the guild
+     * @param userId - The id of the user
+     * @param avatarHash - The hash provided by Discord for this avatar
+     * @param options - Optional options for the avatar
      */
     guildMemberAvatar(guildId: string, userId: string, avatarHash: string, options?: Readonly<ImageURLOptions>): string;
     /**
      * Generates a guild member banner URL.
-     * @param guildId The id of the guild
-     * @param userId The id of the user
-     * @param bannerHash The hash provided by Discord for this banner
-     * @param options Optional options for the banner
+     *
+     * @param guildId - The id of the guild
+     * @param userId - The id of the user
+     * @param bannerHash - The hash provided by Discord for this banner
+     * @param options - Optional options for the banner
      */
     guildMemberBanner(guildId: string, userId: string, bannerHash: string, options?: Readonly<ImageURLOptions>): string;
     /**
      * Generates an icon URL, e.g. for a guild.
-     * @param id The id that has the icon splash
-     * @param iconHash The hash provided by Discord for this icon
-     * @param options Optional options for the icon
+     *
+     * @param id - The id that has the icon splash
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
      */
     icon(id: string, iconHash: string, options?: Readonly<ImageURLOptions>): string;
     /**
      * Generates a URL for the icon of a role
-     * @param roleId The id of the role that has the icon
-     * @param roleIconHash The hash provided by Discord for this role icon
-     * @param options Optional options for the role icon
+     * @param roleId - The id of the role that has the icon
+     * @param roleIconHash - The hash provided by Discord for this role icon
+     * @param options - Optional options for the role icon
      */
     roleIcon(roleId: string, roleIconHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates a guild invite splash URL for a guild's invite splash.
-     * @param guildId The guild id that has the invite splash
-     * @param splashHash The hash provided by Discord for this splash
-     * @param options Optional options for the splash
+     *
+     * @param guildId - The guild id that has the invite splash
+     * @param splashHash - The hash provided by Discord for this splash
+     * @param options - Optional options for the splash
      */
     splash(guildId: string, splashHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates a sticker URL.
-     * @param stickerId The sticker id
-     * @param extension The extension of the sticker
+     *
+     * @param stickerId - The sticker id
+     * @param extension - The extension of the sticker
      */
     sticker(stickerId: string, extension?: StickerExtension): string;
     /**
      * Generates a sticker pack banner URL.
-     * @param bannerId The banner id
-     * @param options Optional options for the banner
+     *
+     * @param bannerId - The banner id
+     * @param options - Optional options for the banner
      */
     stickerPackBanner(bannerId: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates a team icon URL for a team's icon.
-     * @param teamId The team id that has the icon
-     * @param iconHash The hash provided by Discord for this icon
-     * @param options Optional options for the icon
+     *
+     * @param teamId - The team id that has the icon
+     * @param iconHash - The hash provided by Discord for this icon
+     * @param options - Optional options for the icon
      */
     teamIcon(teamId: string, iconHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Generates a cover image for a guild scheduled event.
-     * @param scheduledEventId The scheduled event id
-     * @param coverHash The hash provided by discord for this cover image
-     * @param options Optional options for the cover image
+     *
+     * @param scheduledEventId - The scheduled event id
+     * @param coverHash - The hash provided by discord for this cover image
+     * @param options - Optional options for the cover image
      */
     guildScheduledEventCover(scheduledEventId: string, coverHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
-     * @param route The base cdn route
-     * @param hash The hash provided by Discord for this icon
-     * @param options Optional options for the link
+     *
+     * @param route - The base cdn route
+     * @param hash - The hash provided by Discord for this icon
+     * @param options - Optional options for the link
      */
     private dynamicMakeURL;
     /**
      * Constructs the URL for the resource
-     * @param route The base cdn route
-     * @param options The extension/size options for the link
+     *
+     * @param route - The base cdn route
+     * @param options - The extension/size options for the link
      */
     private makeURL;
 }
@@ -698,12 +753,12 @@ declare class DiscordAPIError extends Error {
     url: string;
     requestBody: RequestBody;
     /**
-     * @param rawError The error reported by Discord
-     * @param code The error code reported by Discord
-     * @param status The status code of the response
-     * @param method The method of the request that erred
-     * @param url The url of the request that erred
-     * @param bodyData The unparsed data for the request that errored
+     * @param rawError - The error reported by Discord
+     * @param code - The error code reported by Discord
+     * @param status - The status code of the response
+     * @param method - The method of the request that erred
+     * @param url - The url of the request that erred
+     * @param bodyData - The unparsed data for the request that errored
      */
     constructor(rawError: DiscordErrorData | OAuthErrorData, code: number | string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
     /**
@@ -724,11 +779,11 @@ declare class HTTPError extends Error {
     url: string;
     requestBody: RequestBody;
     /**
-     * @param name The name of the error
-     * @param status The status code of the response
-     * @param method The method of the request that erred
-     * @param url The url of the request that erred
-     * @param bodyData The unparsed data for the request that errored
+     * @param name - The name of the error
+     * @param status - The status code of the response
+     * @param method - The method of the request that erred
+     * @param url - The url of the request that erred
+     * @param bodyData - The unparsed data for the request that errored
      */
     constructor(name: string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
 }
@@ -752,13 +807,16 @@ declare class RateLimitError extends Error implements RateLimitData {
 /**
  * Creates and populates an URLSearchParams instance from an object, stripping
  * out null and undefined values, while also coercing non-strings to strings.
- * @param options The options to use
+ *
+ * @param options - The options to use
+ *
  * @returns A populated URLSearchParams instance
  */
 declare function makeURLSearchParams(options?: Record<string, unknown>): URLSearchParams$1;
 /**
  * Converts the response to usable data
- * @param res The fetch response
+ *
+ * @param res - The fetch response
  */
 declare function parseResponse(res: Dispatcher.ResponseData): Promise<unknown>;
 

package/dist/index.js

@@ -50,13 +50,13 @@ var require_package = __commonJS({
   "package.json"(exports, module2) {
     module2.exports = {
       name: "@discordjs/rest",
-      version: "0.6.0-dev.1656547798-27d8deb",
+      version: "0.6.0-dev.1656677085-741b3c8",
       description: "The REST API for discord.js",
       scripts: {
         build: "tsup",
         lint: "prettier --cache --check . && eslint src __tests__ --ext mjs,js,ts --cache",
         format: "prettier --cache --write . && eslint src __tests__ --ext mjs,js,ts --fix --cache",
-        docs: "docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript",
+        docs: "docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript && api-extractor run --local",
         prepack: "yarn build && yarn lint",
         changelog: "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/rest/*'",
         release: "cliff-jumper"
@@ -111,6 +111,7 @@ var require_package = __commonJS({
         "@discordjs/docgen": "workspace:^",
         "@discordjs/scripts": "workspace:^",
         "@favware/cliff-jumper": "^1.8.3",
+        "@microsoft/api-extractor": "^7.28.2",
         eslint: "^8.18.0",
         prettier: "^2.7.1",
         tsup: "^6.1.2",