Class Arg

Index

Methods

optionalApplicationEmoji optionalAttachment optionalAutomodRule optionalBigInt optionalBoolean optionalChannel optionalColor optionalDate optionalEmoji optionalEnum optionalForumTag optionalGuild optionalGuildEmoji optionalInvite optionalJson optionalMember optionalMessage optionalNumber optionalOverwritePermission optionalPermission optionalReaction optionalRole optionalRoleOrUser optionalScheduledEvent optionalSoundboardSound optionalStageInstance optionalSticker optionalString optionalTemplate optionalTextChannel optionalTime optionalURL optionalUser optionalWebhook requiredApplicationEmoji requiredAttachment requiredAutomodRule requiredBigInt requiredBoolean requiredChannel requiredColor requiredDate requiredEmoji requiredEnum requiredForumTag requiredGuild requiredGuildEmoji requiredInvite requiredJson requiredMember requiredMessage requiredNumber requiredOverwritePermission requiredPermission requiredReaction requiredRole requiredRoleOrUser requiredScheduledEvent requiredSoundboardSound requiredStageInstance requiredSticker requiredString requiredTemplate requiredTextChannel requiredTime requiredURL requiredUser requiredWebhook restApplicationEmoji restAttachment restAutomodRule restBigInt restBoolean restChannel restColor restDate restEmoji restEnum restForumTag restGuild restGuildEmoji restInvite restJson restMember restMessage restNumber restOverwritePermission restPermission restReaction restRole restRoleOrUser restScheduledEvent restSoundboardSound restStageInstance restSticker restString restTemplate restTextChannel restTime restURL restUser restWebhook

Methods

`Static`optionalApplicationEmoji

optionalApplicationEmoji(
name?: string,
desc?: string,
): IArg<ApplicationEmoji, boolean, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The application emoji to use"
Returns IArg<ApplicationEmoji, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:601

`Static`optionalAttachment

optionalAttachment(
name?: string,
desc?: string,
): IArg<Attachment, boolean, false, EnumLike>
Parameters
- name: string = "attachment"
- desc: string = "The attachment to use"
Returns IArg<Attachment, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:659

`Static`optionalAutomodRule

optionalAutomodRule(
name?: string,
desc?: string,
): IArg<AutomodRule, boolean, false, EnumLike>
Parameters
- name: string = "rule ID"
- desc: string = "The guild automod rule to use"
Returns IArg<AutomodRule, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:370

`Static`optionalBigInt

optionalBigInt(
name?: string,
desc?: string,
): IArg<BigInt, boolean, false, EnumLike>
Parameters
- name: string = "bigint"
- desc: string = "The bigint to use"
Returns IArg<BigInt, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:678

`Static`optionalBoolean

optionalBoolean(
name?: string,
desc?: string,
): IArg<Boolean, boolean, false, EnumLike>
Parameters
- name: string = "bool"
- desc: string = "The boolean to use"
Returns IArg<Boolean, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:736

`Static`optionalChannel

optionalChannel(
name?: string,
desc?: string,
): IArg<Channel, boolean, false, EnumLike>
Parameters
- name: string = "channel IDs"
- desc: string = "The channel to use"
Returns IArg<Channel, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:72

`Static`optionalColor

optionalColor(
name?: string,
desc?: string,
): IArg<Color, boolean, false, EnumLike>
Parameters
- name: string = "color hex/int"
- desc: string = "The color to use"
Returns IArg<Color, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:132

`Static`optionalDate

optionalDate(name?: string, desc?: string): IArg<Date, boolean, false, EnumLike>
Parameters
- name: string = "timestamp/date"
- desc: string = "The timestamp/date to use"
Returns IArg<Date, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:923

`Static`optionalEmoji

optionalEmoji(
name?: string,
desc?: string,
): IArg<Emoji, boolean, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The emoji to use"
Returns IArg<Emoji, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:630

`Static`optionalEnum

optionalEnum<T extends EnumLike>(
    en: T,
    name?: string,
    desc?: string,
): IArg<Enum, boolean, false, T>
Type Parameters
- T extends EnumLike
Parameters
- en: T
- name: string = "enum value"
- desc: string = "The enum value to use"
Returns IArg<Enum, boolean, false, T>
- Defined in src/structures/@internal/Arg.ts:100

`Static`optionalForumTag

optionalForumTag(
name?: string,
desc?: string,
): IArg<ForumTag, boolean, false, EnumLike>
Parameters
- name: string = "tag ID"
- desc: string = "The forum tag to use"
Returns IArg<ForumTag, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:498

`Static`optionalGuild

optionalGuild(
name?: string,
desc?: string,
): IArg<Guild, boolean, false, EnumLike>
Parameters
- name: string = "guild ID"
- desc: string = "The guild to use"
Returns IArg<Guild, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:161

`Static`optionalGuildEmoji

optionalGuildEmoji(
name?: string,
desc?: string,
): IArg<GuildEmoji, boolean, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The guild emoji to use"
Returns IArg<GuildEmoji, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:570

`Static`optionalInvite

optionalInvite(
name?: string,
desc?: string,
): IArg<Invite, boolean, false, EnumLike>
Parameters
- name: string = "invite code"
- desc: string = "The invite code to use"
Returns IArg<Invite, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:775

`Static`optionalJson

optionalJson(name?: string, desc?: string): IArg<Json, boolean, false, EnumLike>
Parameters
- name: string = "json data"
- desc: string = "The JSON valid value to use"
Returns IArg<Json, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:251

`Static`optionalMember

optionalMember(
name?: string,
desc?: string,
): IArg<Member, boolean, false, EnumLike>
Parameters
- name: string = "member ID"
- desc: string = "The guild member to use"
Returns IArg<Member, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:338

`Static`optionalMessage

optionalMessage(
name?: string,
desc?: string,
): IArg<Message, boolean, false, EnumLike>
Parameters
- name: string = "message ID"
- desc: string = "The message to use"
Returns IArg<Message, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:40

`Static`optionalNumber

optionalNumber(
name?: string,
desc?: string,
): IArg<Number, boolean, false, EnumLike>
Parameters
- name: string = "number"
- desc: string = "The number to use"
Returns IArg<Number, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:280

`Static`optionalOverwritePermission

optionalOverwritePermission(
name?: string,
desc?: string,
): IArg<OverwritePermission, boolean, false, EnumLike>
Parameters
- name: string = "overwrite permission"
- desc: string = "The overwrite permission to use, preceded by (/,-,+)"
Returns IArg<OverwritePermission, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:991

`Static`optionalPermission

optionalPermission(
name?: string,
desc?: string,
): IArg<Permission, boolean, false, EnumLike>
Parameters
- name: string = "permissions"
- desc: string = "The permission to use"
Returns IArg<Permission, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:952

`Static`optionalReaction

optionalReaction(
name?: string,
desc?: string,
): IArg<Reaction, boolean, false, EnumLike>
Parameters
- name: string = "reaction emoji"
- desc: string = "The reaction emoji to use"
Returns IArg<Reaction, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:852

`Static`optionalRole

optionalRole(name?: string, desc?: string): IArg<Role, boolean, false, EnumLike>
Parameters
- name: string = "role ID"
- desc: string = "The role to use"
Returns IArg<Role, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:190

`Static`optionalRoleOrUser

optionalRoleOrUser(
name?: string,
desc?: string,
): IArg<RoleOrUser, boolean, false, EnumLike>
Parameters
- name: string = "role/user"
- desc: string = "The role/user to use"
Returns IArg<RoleOrUser, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:1000

`Static`optionalScheduledEvent

optionalScheduledEvent(
name?: string,
desc?: string,
): IArg<ScheduledEvent, boolean, false, EnumLike>
Parameters
- name: string = "event ID"
- desc: string = "The guild scheduled event to use"
Returns IArg<ScheduledEvent, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:402

`Static`optionalSoundboardSound

optionalSoundboardSound(
name?: string,
desc?: string,
): IArg<SoundboardSound, boolean, false, EnumLike>
Parameters
- name: string = "sound ID"
- desc: string = "The soundboard sound to use"
Returns IArg<SoundboardSound, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:466

`Static`optionalStageInstance

optionalStageInstance(
name?: string,
desc?: string,
): IArg<StageInstance, boolean, false, EnumLike>
Parameters
- name: string = "stage ID"
- desc: string = "The stage instance to use"
Returns IArg<StageInstance, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:434

`Static`optionalSticker

optionalSticker(
name?: string,
desc?: string,
): IArg<Sticker, boolean, false, EnumLike>
Parameters
- name: string = "sticker ID"
- desc: string = "The sticker to use"
Returns IArg<Sticker, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:222

`Static`optionalString

optionalString(
name?: string,
desc?: string,
): IArg<String, boolean, false, EnumLike>
Parameters
- name: string = "string"
- desc: string = "The string to use"
Returns IArg<String, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:11

`Static`optionalTemplate

optionalTemplate(
name?: string,
desc?: string,
): IArg<Template, boolean, false, EnumLike>
Parameters
- name: string = "template code"
- desc: string = "The template code to use"
Returns IArg<Template, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:833

`Static`optionalTextChannel

optionalTextChannel(
name?: string,
desc?: string,
): IArg<TextChannel, boolean, false, EnumLike>
Parameters
- name: string = "text channel ID"
- desc: string = "The text channel to use"
Returns IArg<TextChannel, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:540

`Static`optionalTime

optionalTime(name?: string, desc?: string): IArg<Time, boolean, false, EnumLike>
Parameters
- name: string = "duration/time"
- desc: string = "The duration/time to use"
Returns IArg<Time, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:894

`Static`optionalURL

optionalURL(name?: string, desc?: string): IArg<URL, boolean, false, EnumLike>
Parameters
- name: string = "url"
- desc: string = "The url to use"
Returns IArg<URL, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:707

`Static`optionalUser

optionalUser(name?: string, desc?: string): IArg<User, boolean, false, EnumLike>
Parameters
- name: string = "user ID"
- desc: string = "The user to use"
Returns IArg<User, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:329

`Static`optionalWebhook

optionalWebhook(
name?: string,
desc?: string,
): IArg<Webhook, boolean, false, EnumLike>
Parameters
- name: string = "webhook ID"
- desc: string = "The webhook to use"
Returns IArg<Webhook, boolean, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:814

`Static`requiredApplicationEmoji

requiredApplicationEmoji(
name?: string,
desc?: string,
): IArg<ApplicationEmoji, true, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The application emoji to use"
Returns IArg<ApplicationEmoji, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:610

`Static`requiredAttachment

requiredAttachment(
name?: string,
desc?: string,
): IArg<Attachment, true, false, EnumLike>
Parameters
- name: string = "attachment"
- desc: string = "The attachment to use"
Returns IArg<Attachment, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:668

`Static`requiredAutomodRule

requiredAutomodRule(
name?: string,
desc?: string,
): IArg<AutomodRule, true, false, EnumLike>
Parameters
- name: string = "rule ID"
- desc: string = "The guild automod rule to use"
Returns IArg<AutomodRule, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:391

`Static`requiredBigInt

requiredBigInt(
name?: string,
desc?: string,
): IArg<BigInt, true, false, EnumLike>
Parameters
- name: string = "bigint"
- desc: string = "The bigint to use"
Returns IArg<BigInt, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:687

`Static`requiredBoolean

requiredBoolean(
name?: string,
desc?: string,
): IArg<Boolean, true, false, EnumLike>
Parameters
- name: string = "bool"
- desc: string = "The boolean to use"
Returns IArg<Boolean, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:755

`Static`requiredChannel

requiredChannel(
name?: string,
desc?: string,
): IArg<Channel, boolean, true, EnumLike>
Parameters
- name: string = "channel ID"
- desc: string = "The channel to use"
Returns IArg<Channel, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:91

`Static`requiredColor

requiredColor(name?: string, desc?: string): IArg<Color, true, false, EnumLike>
Parameters
- name: string = "color hex/int"
- desc: string = "The color to use"
Returns IArg<Color, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:141

`Static`requiredDate

requiredDate(name?: string, desc?: string): IArg<Date, true, false, EnumLike>
Parameters
- name: string = "timestamp/date"
- desc: string = "The timestamp/date to use"
Returns IArg<Date, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:913

`Static`requiredEmoji

requiredEmoji(name?: string, desc?: string): IArg<Emoji, true, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The emoji to use"
Returns IArg<Emoji, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:639

`Static`requiredEnum

requiredEnum<T extends EnumLike>(
    en: T,
    name?: string,
    desc?: string,
): IArg<Enum, true, false, T>
Type Parameters
- T extends EnumLike
Parameters
- en: T
- name: string = "enum value"
- desc: string = "The enum values to use"
Returns IArg<Enum, true, false, T>
- Defined in src/structures/@internal/Arg.ts:110

`Static`requiredForumTag

requiredForumTag(
name?: string,
desc?: string,
): IArg<ForumTag, true, false, EnumLike>
Parameters
- name: string = "tag ID"
- desc: string = "The forum tag to use"
Returns IArg<ForumTag, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:508

`Static`requiredGuild

requiredGuild(name?: string, desc?: string): IArg<Guild, true, false, EnumLike>
Parameters
- name: string = "guild ID"
- desc: string = "The guild to use"
Returns IArg<Guild, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:180

`Static`requiredGuildEmoji

requiredGuildEmoji(
name?: string,
desc?: string,
): IArg<GuildEmoji, true, false, EnumLike>
Parameters
- name: string = "emoji ID"
- desc: string = "The guild emoji to use"
Returns IArg<GuildEmoji, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:580

`Static`requiredInvite

requiredInvite(
name?: string,
desc?: string,
): IArg<Invite, true, false, EnumLike>
Parameters
- name: string = "invite code"
- desc: string = "The invite code to use"
Returns IArg<Invite, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:765

`Static`requiredJson

requiredJson(name?: string, desc?: string): IArg<Json, true, false, EnumLike>
Parameters
- name: string = "json data"
- desc: string = "The JSON valid value to use"
Returns IArg<Json, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:270

`Static`requiredMember

requiredMember(
name?: string,
desc?: string,
): IArg<Member, true, false, EnumLike>
Parameters
- name: string = "member ID"
- desc: string = "The guild member to use"
Returns IArg<Member, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:359

`Static`requiredMessage

requiredMessage(
name?: string,
desc?: string,
): IArg<Message, true, false, EnumLike>
Parameters
- name: string = "message ID"
- desc: string = "The message to use"
Returns IArg<Message, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:61

`Static`requiredNumber

requiredNumber(
name?: string,
desc?: string,
): IArg<Number, true, false, EnumLike>
Parameters
- name: string = "number"
- desc: string = "The number to use"
Returns IArg<Number, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:289

`Static`requiredOverwritePermission

requiredOverwritePermission(
name?: string,
desc?: string,
): IArg<OverwritePermission, true, false, EnumLike>
Parameters
- name: string = "overwrite permission"
- desc: string = "The overwrite permission to use, preceded by (/,-,+)"
Returns IArg<OverwritePermission, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:971

`Static`requiredPermission

requiredPermission(
name?: string,
desc?: string,
): IArg<Permission, true, false, EnumLike>
Parameters
- name: string = "permission"
- desc: string = "The permission to use"
Returns IArg<Permission, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:961

`Static`requiredReaction

requiredReaction(
name?: string,
desc?: string,
): IArg<Reaction, true, false, EnumLike>
Parameters
- name: string = "reaction emoji"
- desc: string = "The reaction emoji to use"
Returns IArg<Reaction, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:862

`Static`requiredRole

requiredRole(name?: string, desc?: string): IArg<Role, true, false, EnumLike>
Parameters
- name: string = "role ID"
- desc: string = "The role to use"
Returns IArg<Role, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:200

`Static`requiredRoleOrUser

requiredRoleOrUser(
name?: string,
desc?: string,
): IArg<RoleOrUser, true, false, EnumLike>
Parameters
- name: string = "role/user"
- desc: string = "The role/user to use"
Returns IArg<RoleOrUser, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:1023

`Static`requiredScheduledEvent

requiredScheduledEvent(
name?: string,
desc?: string,
): IArg<ScheduledEvent, true, false, EnumLike>
Parameters
- name: string = "event ID"
- desc: string = "The guild scheduled event to use"
Returns IArg<ScheduledEvent, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:423

`Static`requiredSoundboardSound

requiredSoundboardSound(
name?: string,
desc?: string,
): IArg<SoundboardSound, true, false, EnumLike>
Parameters
- name: string = "sound ID"
- desc: string = "The soundboard sound to use"
Returns IArg<SoundboardSound, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:487

`Static`requiredStageInstance

requiredStageInstance(
name?: string,
desc?: string,
): IArg<StageInstance, true, false, EnumLike>
Parameters
- name: string = "stage ID"
- desc: string = "The stage instance to use"
Returns IArg<StageInstance, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:455

`Static`requiredSticker

requiredSticker(
name?: string,
desc?: string,
): IArg<Sticker, true, false, EnumLike>
Parameters
- name: string = "sticker ID"
- desc: string = "The sticker to use"
Returns IArg<Sticker, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:231

`Static`requiredString

requiredString(
name?: string,
desc?: string,
): IArg<String, true, false, EnumLike>
Parameters
- name: string = "string"
- desc: string = "The string to use"
Returns IArg<String, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:20

`Static`requiredTemplate

requiredTemplate(
name?: string,
desc?: string,
): IArg<Template, true, false, EnumLike>
Parameters
- name: string = "template code"
- desc: string = "The template code to use"
Returns IArg<Template, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:823

`Static`requiredTextChannel

requiredTextChannel(
name?: string,
desc?: string,
): IArg<TextChannel, true, false, EnumLike>
Parameters
- name: string = "text channel ID"
- desc: string = "The text channel to use"
Returns IArg<TextChannel, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:549

`Static`requiredTime

requiredTime(name?: string, desc?: string): IArg<Time, true, false, EnumLike>
Parameters
- name: string = "duration/time"
- desc: string = "The duration/time to use"
Returns IArg<Time, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:903

`Static`requiredURL

requiredURL(name?: string, desc?: string): IArg<URL, true, false, EnumLike>
Parameters
- name: string = "url"
- desc: string = "The url to use"
Returns IArg<URL, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:716

`Static`requiredUser

requiredUser(name?: string, desc?: string): IArg<User, true, false, EnumLike>
Parameters
- name: string = "user ID"
- desc: string = "The user to use"
Returns IArg<User, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:319

`Static`requiredWebhook

requiredWebhook(
name?: string,
desc?: string,
): IArg<Webhook, true, false, EnumLike>
Parameters
- name: string = "webhook ID"
- desc: string = "The webhook to use"
Returns IArg<Webhook, true, false, EnumLike>
- Defined in src/structures/@internal/Arg.ts:804

`Static`restApplicationEmoji

restApplicationEmoji(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<ApplicationEmoji, boolean, true, EnumLike>
Parameters
- name: string = "emoji IDs"
- desc: string = "The application emojis to use"
- required: boolean = false
Returns IArg<ApplicationEmoji, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:591

`Static`restAttachment

restAttachment(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Attachment, boolean, true, EnumLike>
Parameters
- name: string = "attachments"
- desc: string = "The attachments to use"
- required: boolean = false
Returns IArg<Attachment, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:649

`Static`restAutomodRule

restAutomodRule(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<AutomodRule, boolean, true, EnumLike>
Parameters
- name: string = "rule IDs"
- desc: string = "The guild automod rule to use"
- required: boolean = false
Returns IArg<AutomodRule, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:380

`Static`restBigInt

restBigInt(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<BigInt, boolean, true, EnumLike>
Parameters
- name: string = "bigints"
- desc: string = "The bigints to use"
- required: boolean = false
Returns IArg<BigInt, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:697

`Static`restBoolean

restBoolean(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Boolean, boolean, true, EnumLike>
Parameters
- name: string = "bools"
- desc: string = "The booleans to use"
- required: boolean = false
Returns IArg<Boolean, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:745

`Static`restChannel

restChannel(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Channel, boolean, true, EnumLike>
Parameters
- name: string = "channel IDs"
- desc: string = "The channels to use"
- required: boolean = false
Returns IArg<Channel, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:81

`Static`restColor

restColor(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Color, boolean, true, EnumLike>
Parameters
- name: string = "color hex/int(s)"
- desc: string = "The colors to use"
- required: boolean = false
Returns IArg<Color, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:151

`Static`restDate

restDate(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Date, boolean, true, EnumLike>
Parameters
- name: string = "timestamp/date"
- desc: string = "The timestamp/date to use"
- required: boolean = false
Returns IArg<Date, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:932

`Static`restEmoji

restEmoji(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Emoji, boolean, true, EnumLike>
Parameters
- name: string = "emoji IDs"
- desc: string = "The emojis to use"
- required: boolean = false
Returns IArg<Emoji, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:620

`Static`restEnum

restEnum<T extends EnumLike>(
    en: T,
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Enum, boolean, true, T>
Type Parameters
- T extends EnumLike
Parameters
- en: T
- name: string = "enum values"
- desc: string = "The enum values to use"
- required: boolean = false
Returns IArg<Enum, boolean, true, T>
- Defined in src/structures/@internal/Arg.ts:121

`Static`restForumTag

restForumTag(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<ForumTag, boolean, true, EnumLike>
Parameters
- name: string = "tag IDs"
- desc: string = "The forum tags to use"
- required: boolean = false
Returns IArg<ForumTag, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:519

`Static`restGuild

restGuild(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Guild, boolean, true, EnumLike>
Parameters
- name: string = "guild IDs"
- desc: string = "The guilds to use"
- required: boolean = false
Returns IArg<Guild, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:170

`Static`restGuildEmoji

restGuildEmoji(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<GuildEmoji, boolean, true, EnumLike>
Parameters
- name: string = "emoji IDs"
- desc: string = "The guild emojis to use"
- required: boolean = false
Returns IArg<GuildEmoji, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:559

`Static`restInvite

restInvite(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Invite, boolean, true, EnumLike>
Parameters
- name: string = "invite codes"
- desc: string = "The invite codes to use"
- required: boolean = false
Returns IArg<Invite, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:784

`Static`restJson

restJson(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Json, boolean, true, EnumLike>
Parameters
- name: string = "json datas"
- desc: string = "The JSON valid values to use"
- required: boolean = false
Returns IArg<Json, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:260

`Static`restMember

restMember(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Member, boolean, true, EnumLike>
Parameters
- name: string = "member IDs"
- desc: string = "The guild members to use"
- required: boolean = false
Returns IArg<Member, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:348

`Static`restMessage

restMessage(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Message, boolean, true, EnumLike>
Parameters
- name: string = "message IDs"
- desc: string = "The messages to use"
- required: boolean = false
Returns IArg<Message, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:50

`Static`restNumber

restNumber(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Number, boolean, true, EnumLike>
Parameters
- name: string = "numbers"
- desc: string = "The numbers to use"
- required: boolean = false
Returns IArg<Number, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:299

`Static`restOverwritePermission

restOverwritePermission(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<OverwritePermission, boolean, true, EnumLike>
Parameters
- name: string = "overwrite permissions"
- desc: string = "The overwrite permissions to use, preceded by (/,-,+)"
- required: boolean = false
Returns IArg<OverwritePermission, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:981

`Static`restPermission

restPermission(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Permission, boolean, true, EnumLike>
Parameters
- name: string = "permissions"
- desc: string = "The permissions to use"
- required: boolean = false
Returns IArg<Permission, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:942

`Static`restReaction

restReaction(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Reaction, boolean, true, EnumLike>
Parameters
- name: string = "reaction emojis"
- desc: string = "The reaction emojis to use"
- required: boolean = false
Returns IArg<Reaction, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:873

`Static`restRole

restRole(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Role, boolean, true, EnumLike>
Parameters
- name: string = "role IDs"
- desc: string = "The roles to use"
- required: boolean = false
Returns IArg<Role, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:211

`Static`restRoleOrUser

restRoleOrUser(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<RoleOrUser, boolean, true, EnumLike>
Parameters
- name: string = "role/user(s)"
- desc: string = "The role/user(s) to use"
- required: boolean = false
Returns IArg<RoleOrUser, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:1011

`Static`restScheduledEvent

restScheduledEvent(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<ScheduledEvent, boolean, true, EnumLike>
Parameters
- name: string = "event IDs"
- desc: string = "The guild scheduled events to use"
- required: boolean = false
Returns IArg<ScheduledEvent, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:412

`Static`restSoundboardSound

restSoundboardSound(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<SoundboardSound, boolean, true, EnumLike>
Parameters
- name: string = "sound IDs"
- desc: string = "The soundboard sounds to use"
- required: boolean = false
Returns IArg<SoundboardSound, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:476

`Static`restStageInstance

restStageInstance(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<StageInstance, boolean, true, EnumLike>
Parameters
- name: string = "stage IDs"
- desc: string = "The stage instances to use"
- required: boolean = false
Returns IArg<StageInstance, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:444

`Static`restSticker

restSticker(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Sticker, boolean, true, EnumLike>
Parameters
- name: string = "sticker IDs"
- desc: string = "The stickers to use"
- required: boolean = false
Returns IArg<Sticker, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:241

`Static`restString

restString(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<String, boolean, true, EnumLike>
Parameters
- name: string = "strings"
- desc: string = "The strings to use"
- required: boolean = false
Returns IArg<String, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:30

`Static`restTemplate

restTemplate(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Template, boolean, true, EnumLike>
Parameters
- name: string = "template codes"
- desc: string = "The template codes to use"
- required: boolean = false
Returns IArg<Template, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:842

`Static`restTextChannel

restTextChannel(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<TextChannel, boolean, true, EnumLike>
Parameters
- name: string = "text channel IDs"
- desc: string = "The text channels to use"
- required: boolean = false
Returns IArg<TextChannel, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:530

`Static`restTime

restTime(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Time, boolean, true, EnumLike>
Parameters
- name: string = "duration/time"
- desc: string = "The duration/time to use"
- required: boolean = false
Returns IArg<Time, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:884

`Static`restURL

restURL(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<URL, boolean, true, EnumLike>
Parameters
- name: string = "urls"
- desc: string = "The urls to use"
- required: boolean = false
Returns IArg<URL, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:726

`Static`restUser

restUser(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<User, boolean, true, EnumLike>
Parameters
- name: string = "user IDs"
- desc: string = "The users to use"
- required: boolean = false
Returns IArg<User, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:309

`Static`restWebhook

restWebhook(
    name?: string,
    desc?: string,
    required?: boolean,
): IArg<Webhook, boolean, true, EnumLike>
Parameters
- name: string = "webhook IDs"
- desc: string = "The webhooks to use"
- required: boolean = false
Returns IArg<Webhook, boolean, true, EnumLike>
- Defined in src/structures/@internal/Arg.ts:794