From a5d949e650fbc325c6b619da00edfa66d28abc72 Mon Sep 17 00:00:00 2001 From: Qjuh <76154676+Qjuh@users.noreply.github.com> Date: Mon, 12 May 2025 23:13:31 +0200 Subject: [PATCH] fix: wrong exports reported by ae (#1239) --- .gitignore | 4 ++ api-extractor.json | 107 ++++++++++++++++++++++++++++++++++ deno/payloads/v10/auditLog.ts | 2 +- deno/rest/v10/mod.ts | 2 +- deno/rest/v9/mod.ts | 2 +- deno/rpc/common.ts | 37 ------------ deno/rpc/v10.ts | 47 +++++++++++++-- deno/rpc/v8.ts | 40 +++++++++++++ deno/rpc/v9.ts | 40 +++++++++++++ deno/utils/v8.ts | 16 ++--- payloads/v10/auditLog.ts | 2 +- rest/v10/index.ts | 2 +- rest/v9/index.ts | 2 +- rpc/common.ts | 37 ------------ rpc/v10.ts | 47 +++++++++++++-- rpc/v8.ts | 40 +++++++++++++ rpc/v9.ts | 40 +++++++++++++ tsdoc.json | 71 ++++++++++++++++++++++ utils/v8.ts | 16 ++--- 19 files changed, 450 insertions(+), 104 deletions(-) create mode 100644 api-extractor.json create mode 100644 tsdoc.json diff --git a/.gitignore b/.gitignore index fd9e2f8b..cf104fa2 100644 --- a/.gitignore +++ b/.gitignore @@ -56,5 +56,9 @@ voice/**/*.map voice/**/*.d.ts voice/**/*.mjs +# Don't commit generated docs +tsdoc-metadata.json +docs/* + # macOS files .DS_Store diff --git a/api-extractor.json b/api-extractor.json new file mode 100644 index 00000000..249235b5 --- /dev/null +++ b/api-extractor.json @@ -0,0 +1,107 @@ +{ + "$schema": "../discord.js/packages/api-extractor/src/schemas/api-extractor.schema.json", + + "mainEntryPointFilePath": "/globals.d.ts", + + "additionalEntryPoints": [ + { "modulePath": "v10", "filePath": "/v10.d.ts" }, + { "modulePath": "v9", "filePath": "/v9.d.ts" }, + { "modulePath": "v8", "filePath": "/v8.d.ts" }, + { "modulePath": "v6", "filePath": "/v6.d.ts" }, + { "modulePath": "payloads", "filePath": "/payloads/index.d.ts" }, + { "modulePath": "payloads/v6", "filePath": "/payloads/v6/index.d.ts" }, + { "modulePath": "payloads/v8", "filePath": "/payloads/v8/index.d.ts" }, + { "modulePath": "payloads/v9", "filePath": "/payloads/v9/index.d.ts" }, + { "modulePath": "payloads/v10", "filePath": "/payloads/v10/index.d.ts" } + ], + + "bundledPackages": [], + + "compiler": { + "overrideTsconfig": { + "compilerOptions": { + "allowUnreachableCode": false, + "allowUnusedLabels": false, + "exactOptionalPropertyTypes": true, + "noFallthroughCasesInSwitch": true, + "noImplicitOverride": true, + "noImplicitReturns": true, + "noPropertyAccessFromIndexSignature": false, + "noUncheckedIndexedAccess": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "strict": true, + + "allowArbitraryExtensions": false, + "allowImportingTsExtensions": false, + "module": "ESNext", + "moduleResolution": "nodenext", + "resolveJsonModule": true, + "resolvePackageJsonExports": false, + "resolvePackageJsonImports": false, + + "declaration": true, + "declarationMap": true, + "importHelpers": false, + "newLine": "lf", + "noEmitHelpers": true, + "outDir": "dist", + "removeComments": false, + "sourceMap": true, + + "esModuleInterop": false, + "forceConsistentCasingInFileNames": true, + "isolatedModules": true, + + "experimentalDecorators": true, + "lib": ["ESNext"], + "target": "ES2022", + "useDefineForClassFields": true + } + } + }, + "apiReport": { + "enabled": false + }, + + "docModel": { + "enabled": true, + + "apiJsonFilePath": "/docs/docs.api.json", + "projectFolderUrl": "https://github.com/discordjs/discord-api-types/tree/main" + }, + + "dtsRollup": { + "enabled": false, + + "untrimmedFilePath": "/v10.d.ts" + }, + + "tsdocMetadata": {}, + + "newlineKind": "lf", + + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + }, + + "ae-missing-release-tag": { + "logLevel": "none" + } + }, + + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/deno/payloads/v10/auditLog.ts b/deno/payloads/v10/auditLog.ts index 6e27ad34..11d6d579 100644 --- a/deno/payloads/v10/auditLog.ts +++ b/deno/payloads/v10/auditLog.ts @@ -325,7 +325,7 @@ export interface APIAuditLogOptions { * - CHANNEL_OVERWRITE_UPDATE * - CHANNEL_OVERWRITE_DELETE * - * **Present only if the {@link APIAuditLogOptions.type | entry type} is "0"** + * **Present only if the {@link APIAuditLogOptions."type" | entry type} is "0"** */ role_name?: string; diff --git a/deno/rest/v10/mod.ts b/deno/rest/v10/mod.ts index 97a53a53..11543c35 100644 --- a/deno/rest/v10/mod.ts +++ b/deno/rest/v10/mod.ts @@ -549,7 +549,7 @@ export const Routes = { * - GET `/users/{user.id}` * - PATCH `/users/@me` * - * @param [userId] - The user ID, defaulted to `@me` + * @param userId - The user ID, defaulted to `@me` */ user(userId: Snowflake | '@me' = '@me') { return `/users/${userId}` as const; diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts index cb1bee0e..fec7914a 100644 --- a/deno/rest/v9/mod.ts +++ b/deno/rest/v9/mod.ts @@ -558,7 +558,7 @@ export const Routes = { * - GET `/users/{user.id}` * - PATCH `/users/@me` * - * @param [userId] - The user ID, defaulted to `@me` + * @param userId - The user ID, defaulted to `@me` */ user(userId: Snowflake | '@me' = '@me') { return `/users/${userId}` as const; diff --git a/deno/rpc/common.ts b/deno/rpc/common.ts index 33cfba11..a84ce41a 100644 --- a/deno/rpc/common.ts +++ b/deno/rpc/common.ts @@ -1,5 +1,4 @@ import type { Snowflake } from '../globals.ts'; -import type { APIMessage, APIUser, RPCVoiceConnectionStatusDispatchData } from '../v10.ts'; /** * @unstable The ping object for the `VOICE_CONNECTION_STATUS` dispatched {@link RPCVoiceConnectionStatusDispatchData.pings} field, @@ -48,24 +47,6 @@ export interface RPCAPIMessageParsedContentMention { content: Omit; } -/** - * @unstable - */ -export interface RPCAPIMessage extends Omit { - /** - * The nickname of the user who sent the message - */ - nick?: string; - /** - * The color of the author's name - */ - author_color?: number; - /** - * The content of the message parsed into an array - */ - content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; -} - /** * @see {@link https://discord.com/developers/docs/topics/rpc#authenticate-oauth2-application-structure} */ @@ -329,24 +310,6 @@ export enum RelationshipType { Implicit, } -/** - * @unstable - */ -export interface Relationship { - /** - * The id of the user - */ - id: Snowflake; - /** - * Relationship type - */ - type: RelationshipType; - /** - * User - */ - user: APIUser; -} - /** * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#rpc-rpc-error-codes} */ diff --git a/deno/rpc/v10.ts b/deno/rpc/v10.ts index a0b4f707..d0de0a2b 100644 --- a/deno/rpc/v10.ts +++ b/deno/rpc/v10.ts @@ -9,8 +9,12 @@ import type { ChannelType, GatewayActivity, OAuth2Scopes, - Relationship, - RPCAPIMessage, + Snowflake, +} from '../v10.ts'; +import type { + RelationshipType, + RPCAPIMessageParsedContentMention, + RPCAPIMessageParsedContentText, RPCCertifiedDevice, RPCErrorCodes, RPCOAuth2Application, @@ -18,14 +22,49 @@ import type { RPCVoiceSettingsInput, RPCVoiceSettingsMode, RPCVoiceSettingsOutput, - Snowflake, VoiceConnectionStates, -} from '../v10.ts'; +} from './common.ts'; export * from './common.ts'; export const RPCVersion = '1'; +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} + /** * @see {@link https://discord.com/developers/docs/topics/rpc#commands-and-events-rpc-commands} */ diff --git a/deno/rpc/v8.ts b/deno/rpc/v8.ts index 85294f1e..76a724a0 100644 --- a/deno/rpc/v8.ts +++ b/deno/rpc/v8.ts @@ -1 +1,41 @@ +import type { Snowflake } from '../globals.ts'; +import type { APIMessage, APIUser } from '../v8.ts'; +import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common.ts'; + export * from './common.ts'; + +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} \ No newline at end of file diff --git a/deno/rpc/v9.ts b/deno/rpc/v9.ts index 85294f1e..fa659036 100644 --- a/deno/rpc/v9.ts +++ b/deno/rpc/v9.ts @@ -1 +1,41 @@ +import type { Snowflake } from '../globals.ts'; +import type { APIMessage, APIUser } from '../v9.ts'; +import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common.ts'; + export * from './common.ts'; + +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} diff --git a/deno/utils/v8.ts b/deno/utils/v8.ts index 183c1d8e..e9276266 100644 --- a/deno/utils/v8.ts +++ b/deno/utils/v8.ts @@ -19,7 +19,7 @@ import { ButtonStyle } from '../payloads/v8/mod.ts'; /** * A type-guard check for DM interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -30,7 +30,7 @@ export function isDMInteraction(interaction: APIInteraction): interaction is API /** * A type-guard check for guild interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -43,7 +43,7 @@ export function isGuildInteraction(interaction: APIInteraction): interaction is /** * A type-guard check for DM application command interactions * - * @param interaction The application command interaction to check against + * @param interaction - The application command interaction to check against * @returns A boolean that indicates if the application command interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -56,7 +56,7 @@ export function isApplicationCommandDMInteraction( /** * A type-guard check for guild application command interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the application command interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -71,7 +71,7 @@ export function isApplicationCommandGuildInteraction( /** * A type-guard check for DM message component interactions * - * @param interaction The message component interaction to check against + * @param interaction - The message component interaction to check against * @returns A boolean that indicates if the message component interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -84,7 +84,7 @@ export function isMessageComponentDMInteraction( /** * A type-guard check for guild message component interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the message component interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -99,7 +99,7 @@ export function isMessageComponentGuildInteraction( /** * A type-guard check for buttons that have a `url` attached to them. * - * @param component The button to check against + * @param component - The button to check against * @returns A boolean that indicates if the button has a `url` attached to it * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -110,7 +110,7 @@ export function isLinkButton(component: APIButtonComponent): component is APIBut /** * A type-guard check for buttons that have a `custom_id` attached to them. * - * @param component The button to check against + * @param component - The button to check against * @returns A boolean that indicates if the button has a `custom_id` attached to it * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ diff --git a/payloads/v10/auditLog.ts b/payloads/v10/auditLog.ts index 55b7d2f3..c330c757 100644 --- a/payloads/v10/auditLog.ts +++ b/payloads/v10/auditLog.ts @@ -325,7 +325,7 @@ export interface APIAuditLogOptions { * - CHANNEL_OVERWRITE_UPDATE * - CHANNEL_OVERWRITE_DELETE * - * **Present only if the {@link APIAuditLogOptions.type | entry type} is "0"** + * **Present only if the {@link APIAuditLogOptions."type" | entry type} is "0"** */ role_name?: string; diff --git a/rest/v10/index.ts b/rest/v10/index.ts index 9af64886..b8a311fc 100644 --- a/rest/v10/index.ts +++ b/rest/v10/index.ts @@ -549,7 +549,7 @@ export const Routes = { * - GET `/users/{user.id}` * - PATCH `/users/@me` * - * @param [userId] - The user ID, defaulted to `@me` + * @param userId - The user ID, defaulted to `@me` */ user(userId: Snowflake | '@me' = '@me') { return `/users/${userId}` as const; diff --git a/rest/v9/index.ts b/rest/v9/index.ts index 0cb77172..f715b5b9 100644 --- a/rest/v9/index.ts +++ b/rest/v9/index.ts @@ -558,7 +558,7 @@ export const Routes = { * - GET `/users/{user.id}` * - PATCH `/users/@me` * - * @param [userId] - The user ID, defaulted to `@me` + * @param userId - The user ID, defaulted to `@me` */ user(userId: Snowflake | '@me' = '@me') { return `/users/${userId}` as const; diff --git a/rpc/common.ts b/rpc/common.ts index 8c282875..21dc0188 100644 --- a/rpc/common.ts +++ b/rpc/common.ts @@ -1,5 +1,4 @@ import type { Snowflake } from '../globals'; -import type { APIMessage, APIUser, RPCVoiceConnectionStatusDispatchData } from '../v10'; /** * @unstable The ping object for the `VOICE_CONNECTION_STATUS` dispatched {@link RPCVoiceConnectionStatusDispatchData.pings} field, @@ -48,24 +47,6 @@ export interface RPCAPIMessageParsedContentMention { content: Omit; } -/** - * @unstable - */ -export interface RPCAPIMessage extends Omit { - /** - * The nickname of the user who sent the message - */ - nick?: string; - /** - * The color of the author's name - */ - author_color?: number; - /** - * The content of the message parsed into an array - */ - content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; -} - /** * @see {@link https://discord.com/developers/docs/topics/rpc#authenticate-oauth2-application-structure} */ @@ -329,24 +310,6 @@ export enum RelationshipType { Implicit, } -/** - * @unstable - */ -export interface Relationship { - /** - * The id of the user - */ - id: Snowflake; - /** - * Relationship type - */ - type: RelationshipType; - /** - * User - */ - user: APIUser; -} - /** * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#rpc-rpc-error-codes} */ diff --git a/rpc/v10.ts b/rpc/v10.ts index 39843e44..860e4507 100644 --- a/rpc/v10.ts +++ b/rpc/v10.ts @@ -9,8 +9,12 @@ import type { ChannelType, GatewayActivity, OAuth2Scopes, - Relationship, - RPCAPIMessage, + Snowflake, +} from '../v10'; +import type { + RelationshipType, + RPCAPIMessageParsedContentMention, + RPCAPIMessageParsedContentText, RPCCertifiedDevice, RPCErrorCodes, RPCOAuth2Application, @@ -18,14 +22,49 @@ import type { RPCVoiceSettingsInput, RPCVoiceSettingsMode, RPCVoiceSettingsOutput, - Snowflake, VoiceConnectionStates, -} from '../v10'; +} from './common'; export * from './common'; export const RPCVersion = '1'; +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} + /** * @see {@link https://discord.com/developers/docs/topics/rpc#commands-and-events-rpc-commands} */ diff --git a/rpc/v8.ts b/rpc/v8.ts index d0b93236..b680148a 100644 --- a/rpc/v8.ts +++ b/rpc/v8.ts @@ -1 +1,41 @@ +import type { Snowflake } from '../globals'; +import type { APIMessage, APIUser } from '../v8'; +import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common'; + export * from './common'; + +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} \ No newline at end of file diff --git a/rpc/v9.ts b/rpc/v9.ts index d0b93236..b277e38c 100644 --- a/rpc/v9.ts +++ b/rpc/v9.ts @@ -1 +1,41 @@ +import type { Snowflake } from '../globals'; +import type { APIMessage, APIUser } from '../v9'; +import type { RelationshipType, RPCAPIMessageParsedContentMention, RPCAPIMessageParsedContentText } from './common'; + export * from './common'; + +/** + * @unstable + */ +export interface Relationship { + /** + * The id of the user + */ + id: Snowflake; + /** + * Relationship type + */ + type: RelationshipType; + /** + * User + */ + user: APIUser; +} + +/** + * @unstable + */ +export interface RPCAPIMessage extends Omit { + /** + * The nickname of the user who sent the message + */ + nick?: string; + /** + * The color of the author's name + */ + author_color?: number; + /** + * The content of the message parsed into an array + */ + content_parsed: (RPCAPIMessageParsedContentMention | RPCAPIMessageParsedContentText)[]; +} diff --git a/tsdoc.json b/tsdoc.json new file mode 100644 index 00000000..38ed6c53 --- /dev/null +++ b/tsdoc.json @@ -0,0 +1,71 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "tagDefinitions": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + }, + { + "tagName": "@mixes", + "syntaxKind": "block" + }, + { + "tagName": "@unstable", + "syntaxKind": "modifier" + }, + { + "tagName": "@default", + "syntaxKind": "block" + } + ], + + /** + * TSDoc tags implemented by API Extractor: + */ + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + + "@betaDocumentation": true, + "@internalRemarks": true, + "@mixes": true, + "@preapproved": true, + + /** + * additional tags for discord-api-types: + */ + "@unstable": true, + "@default": true + } +} diff --git a/utils/v8.ts b/utils/v8.ts index fc411890..32500108 100644 --- a/utils/v8.ts +++ b/utils/v8.ts @@ -19,7 +19,7 @@ import { ButtonStyle } from '../payloads/v8/index'; /** * A type-guard check for DM interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -30,7 +30,7 @@ export function isDMInteraction(interaction: APIInteraction): interaction is API /** * A type-guard check for guild interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -43,7 +43,7 @@ export function isGuildInteraction(interaction: APIInteraction): interaction is /** * A type-guard check for DM application command interactions * - * @param interaction The application command interaction to check against + * @param interaction - The application command interaction to check against * @returns A boolean that indicates if the application command interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -56,7 +56,7 @@ export function isApplicationCommandDMInteraction( /** * A type-guard check for guild application command interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the application command interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -71,7 +71,7 @@ export function isApplicationCommandGuildInteraction( /** * A type-guard check for DM message component interactions * - * @param interaction The message component interaction to check against + * @param interaction - The message component interaction to check against * @returns A boolean that indicates if the message component interaction was received in a DM channel * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -84,7 +84,7 @@ export function isMessageComponentDMInteraction( /** * A type-guard check for guild message component interactions * - * @param interaction The interaction to check against + * @param interaction - The interaction to check against * @returns A boolean that indicates if the message component interaction was received in a guild * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -99,7 +99,7 @@ export function isMessageComponentGuildInteraction( /** * A type-guard check for buttons that have a `url` attached to them. * - * @param component The button to check against + * @param component - The button to check against * @returns A boolean that indicates if the button has a `url` attached to it * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ @@ -110,7 +110,7 @@ export function isLinkButton(component: APIButtonComponent): component is APIBut /** * A type-guard check for buttons that have a `custom_id` attached to them. * - * @param component The button to check against + * @param component - The button to check against * @returns A boolean that indicates if the button has a `custom_id` attached to it * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */