diff --git a/package.json b/package.json index d9809564..0205a759 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "tsup": "^6.2.1", "turbo": "^1.4.0", "typedoc": "^0.23.9", - "typedoc-plugin-external-link": "^1.0.1", + "typedoc-plugin-external-link": "^1.0.2", "typedoc-plugin-mdn-links": "^2.0.0", "typedoc-plugin-resolve-crossmodule-references": "^0.3.0", "typescript": "^4.7.4", diff --git a/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts b/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts index f861f774..4ae71a78 100644 --- a/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts +++ b/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts @@ -21,7 +21,7 @@ import type { EmbedData, APIEmbed } from 'discord.js'; * "image":{"url":"https://random-d.uk/api/randomimg"}, * "color":15194415 * }} - * ``` + * ``` * * Using properties * @usage @@ -36,6 +36,7 @@ import type { EmbedData, APIEmbed } from 'discord.js'; * {embed(description):Follow these rules to ensure a good experience in our server!} * {embed(field):Rule 1|Respect everyone you speak to.|false} * ``` + * * @see The return type depends on user's input. So it might not be `EmbedData | APIEmbed`. So use a typeguard to check. */ export class EmbedParser extends BaseParser implements IParser { diff --git a/scripts/externalConfig.js b/scripts/externalConfig.js index d297a1af..a9a96a86 100644 --- a/scripts/externalConfig.js +++ b/scripts/externalConfig.js @@ -1,4 +1,4 @@ -const packageNames = ['discord.js']; +const packageNames = ['discord.js', 'discord-api-types']; /** * diff --git a/yarn.lock b/yarn.lock index e68249a5..fde1f200 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4539,7 +4539,7 @@ __metadata: tsup: ^6.2.1 turbo: ^1.4.0 typedoc: ^0.23.9 - typedoc-plugin-external-link: ^1.0.1 + typedoc-plugin-external-link: ^1.0.2 typedoc-plugin-mdn-links: ^2.0.0 typedoc-plugin-resolve-crossmodule-references: ^0.3.0 typescript: ^4.7.4 @@ -5437,10 +5437,10 @@ __metadata: languageName: node linkType: hard -"typedoc-plugin-external-link@npm:^1.0.1": - version: 1.0.1 - resolution: "typedoc-plugin-external-link@npm:1.0.1" - checksum: f27ece94a9b5372cd4b05b05fedbb254f496603e1ab5ff4b494335d11896a4a3a8aa431ce81b1fb3efad7cc5dc6090970ac63f746db96ad1aef1466313b38f43 +"typedoc-plugin-external-link@npm:^1.0.2": + version: 1.0.2 + resolution: "typedoc-plugin-external-link@npm:1.0.2" + checksum: 80e70cc1d567152f8b9b61fa6af76de83b110e65eb8bd6e92fbfb3957914b5d2fa6cb22e0545d873112178a474a3f25279d1c4a7fc928918627ef53ad86ea1db languageName: node linkType: hard