Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-18 20:43:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Use @link in @see (#9348)

Browse Source
This commit is contained in:
Jiralite
2023-04-08 22:50:58 +01:00
committed by GitHub
parent 1b9d07f941
commit d66d113333
6 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/brokers/src/brokers/Broker.ts
View File

@@ -26,7 +26,9 @@ export interface BaseBrokerOptions {
*/ */
maxChunk?: number; maxChunk?: number;
/** /**
* Unique consumer name. See: https://redis.io/commands/xreadgroup/ * Unique consumer name.
*
* @see {@link https://redis.io/commands/xreadgroup/}
*/ */
name?: string; name?: string;
} }

2
packages/brokers/src/brokers/redis/BaseRedis.ts
View File

@@ -32,7 +32,7 @@ export abstract class BaseRedisBroker<TEvents extends Record<string, any>>
implements IBaseBroker<TEvents> implements IBaseBroker<TEvents>
{ {
/** /**
* Used for Redis queues, see the 3rd argument taken by {@link https://redis.io/commands/xadd | xadd } * Used for Redis queues, see the 3rd argument taken by {@link https://redis.io/commands/xadd | xadd}
*/ */
public static readonly STREAM_DATA_KEY = 'data'; public static readonly STREAM_DATA_KEY = 'data';

6
packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts
View File

@@ -84,7 +84,7 @@ export class ContextMenuCommandBuilder {
* @remarks * @remarks
* If set to `false`, you will have to later `PUT` the permissions for this command. * If set to `false`, you will have to later `PUT` the permissions for this command.
* @param value - Whether or not to enable this command by default * @param value - Whether or not to enable this command by default
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
* @deprecated Use {@link ContextMenuCommandBuilder.setDefaultMemberPermissions} or {@link ContextMenuCommandBuilder.setDMPermission} instead. * @deprecated Use {@link ContextMenuCommandBuilder.setDefaultMemberPermissions} or {@link ContextMenuCommandBuilder.setDMPermission} instead.
*/ */
public setDefaultPermission(value: boolean) { public setDefaultPermission(value: boolean) {
@@ -102,7 +102,7 @@ export class ContextMenuCommandBuilder {
* @remarks * @remarks
* You can set this to `'0'` to disable the command by default. * You can set this to `'0'` to disable the command by default.
* @param permissions - The permissions bit field to set * @param permissions - The permissions bit field to set
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
*/ */
public setDefaultMemberPermissions(permissions: Permissions | bigint | number | null | undefined) { public setDefaultMemberPermissions(permissions: Permissions | bigint | number | null | undefined) {
// Assert the value and parse it // Assert the value and parse it
@@ -118,7 +118,7 @@ export class ContextMenuCommandBuilder {
* By default, commands are visible. * By default, commands are visible.
* *
* @param enabled - If the command should be enabled in DMs * @param enabled - If the command should be enabled in DMs
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
*/ */
public setDMPermission(enabled: boolean | null | undefined) { public setDMPermission(enabled: boolean | null | undefined) {
// Assert the value matches the conditions // Assert the value matches the conditions

6
packages/builders/src/interactions/slashCommands/SlashCommandBuilder.ts
View File

@@ -95,7 +95,7 @@ export class SlashCommandBuilder {
* @remarks * @remarks
* If set to `false`, you will have to later `PUT` the permissions for this command. * If set to `false`, you will have to later `PUT` the permissions for this command.
* @param value - Whether or not to enable this command by default * @param value - Whether or not to enable this command by default
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
* @deprecated Use {@link (SlashCommandBuilder:class).setDefaultMemberPermissions} or {@link (SlashCommandBuilder:class).setDMPermission} instead. * @deprecated Use {@link (SlashCommandBuilder:class).setDefaultMemberPermissions} or {@link (SlashCommandBuilder:class).setDMPermission} instead.
*/ */
public setDefaultPermission(value: boolean) { public setDefaultPermission(value: boolean) {
@@ -113,7 +113,7 @@ export class SlashCommandBuilder {
* @remarks * @remarks
* You can set this to `'0'` to disable the command by default. * You can set this to `'0'` to disable the command by default.
* @param permissions - The permissions bit field to set * @param permissions - The permissions bit field to set
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
*/ */
public setDefaultMemberPermissions(permissions: Permissions | bigint | number | null | undefined) { public setDefaultMemberPermissions(permissions: Permissions | bigint | number | null | undefined) {
// Assert the value and parse it // Assert the value and parse it
@@ -129,7 +129,7 @@ export class SlashCommandBuilder {
* By default, commands are visible. * By default, commands are visible.
* *
* @param enabled - If the command should be enabled in DMs * @param enabled - If the command should be enabled in DMs
* @see https://discord.com/developers/docs/interactions/application-commands#permissions * @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
*/ */
public setDMPermission(enabled: boolean | null | undefined) { public setDMPermission(enabled: boolean | null | undefined) {
// Assert the value matches the conditions // Assert the value matches the conditions

4
packages/builders/src/interactions/slashCommands/SlashCommandSubcommands.ts
View File

@@ -13,7 +13,7 @@ import { SharedSlashCommandOptions } from './mixins/SharedSlashCommandOptions.js
/** /**
* Represents a folder for subcommands * Represents a folder for subcommands
* *
* For more information, go to https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups * @see {@link https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups}
*/ */
@mix(SharedNameAndDescription) @mix(SharedNameAndDescription)
export class SlashCommandSubcommandGroupBuilder implements ToAPIApplicationCommandOptions { export class SlashCommandSubcommandGroupBuilder implements ToAPIApplicationCommandOptions {
@@ -79,7 +79,7 @@ export interface SlashCommandSubcommandGroupBuilder extends SharedNameAndDescrip
/** /**
* Represents a subcommand * Represents a subcommand
* *
* For more information, go to https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups * @see {@link https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups}
*/ */
@mix(SharedNameAndDescription, SharedSlashCommandOptions) @mix(SharedNameAndDescription, SharedSlashCommandOptions)
export class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions { export class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions {

2
packages/builders/src/messages/embed/Embed.ts
View File

@@ -94,7 +94,7 @@ export class EmbedBuilder {
* *
* @remarks * @remarks
* This method behaves similarly * This method behaves similarly
* to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice | Array.prototype.splice}. * to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice | Array.prototype.splice()}.
* The maximum amount of fields that can be added is 25. * The maximum amount of fields that can be added is 25.
* *
* It's useful for modifying and adjusting order of the already-existing fields of an embed. * It's useful for modifying and adjusting order of the already-existing fields of an embed.