Methods
Static Private create
- create<Type, Required, Rest, Enum>(opts): IArg<Type, Required, Rest, Enum>
Type Parameters
Required extends boolean
Rest extends boolean
Parameters
opts: IArg<Type, Required, Rest, Enum>
Returns IArg<Type, Required, Rest, Enum>
Static optionalApplicationEmoji
- optionalApplicationEmoji(name?, desc?): IArg<ApplicationEmoji, boolean, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The application emoji to use"
Static optionalAttachment
- optionalAttachment(name?, desc?): IArg<Attachment, boolean, false, EnumLike>
Parameters
name: string = "attachment"
desc: string = "The attachment to use"
Static optionalAutomodRule
- optionalAutomodRule(name?, desc?): IArg<AutomodRule, boolean, false, EnumLike>
Parameters
name: string = "rule ID"
desc: string = "The guild automod rule to use"
Static optionalBigInt
- optionalBigInt(name?, desc?): IArg<BigInt, boolean, false, EnumLike>
Parameters
name: string = "bigint"
desc: string = "The bigint to use"
Static optionalBoolean
- optionalBoolean(name?, desc?): IArg<Boolean, boolean, false, EnumLike>
Parameters
name: string = "bool"
desc: string = "The boolean to use"
Static optionalChannel
- optionalChannel(name?, desc?): IArg<Channel, boolean, false, EnumLike>
Parameters
name: string = "channel IDs"
desc: string = "The channel to use"
Static optionalColor
- optionalColor(name?, desc?): IArg<Color, boolean, false, EnumLike>
Parameters
name: string = "color hex/int"
desc: string = "The color to use"
Static optionalDate
- optionalDate(name?, desc?): IArg<Date, boolean, false, EnumLike>
Parameters
name: string = "timestamp/date"
desc: string = "The timestamp/date to use"
Static optionalEmoji
- optionalEmoji(name?, desc?): IArg<Emoji, boolean, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The emoji to use"
Static optionalEnum
- optionalEnum<T>(en, name?, desc?): IArg<Enum, boolean, false, T>
Parameters
en: T
name: string = "enum value"
desc: string = "The enum value to use"
Returns IArg<Enum, boolean, false, T>
Static optionalGuild
- optionalGuild(name?, desc?): IArg<Guild, boolean, false, EnumLike>
Parameters
name: string = "guild ID"
desc: string = "The guild to use"
Static optionalGuildEmoji
- optionalGuildEmoji(name?, desc?): IArg<GuildEmoji, boolean, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The guild emoji to use"
Static optionalInvite
- optionalInvite(name?, desc?): IArg<Invite, boolean, false, EnumLike>
Parameters
name: string = "invite code"
desc: string = "The invite code to use"
Static optionalJson
- optionalJson(name?, desc?): IArg<Json, boolean, false, EnumLike>
Parameters
name: string = "json data"
desc: string = "The JSON valid value to use"
Static optionalMember
- optionalMember(name?, desc?): IArg<Member, boolean, false, EnumLike>
Parameters
name: string = "member ID"
desc: string = "The guild member to use"
Static optionalMessage
- optionalMessage(name?, desc?): IArg<Message, boolean, false, EnumLike>
Parameters
name: string = "message ID"
desc: string = "The message to use"
Static optionalNumber
- optionalNumber(name?, desc?): IArg<Number, boolean, false, EnumLike>
Parameters
name: string = "number"
desc: string = "The number to use"
Static optionalOverwritePermission
- optionalOverwritePermission(name?, desc?): IArg<OverwritePermission, boolean, false, EnumLike>
Parameters
name: string = "overwrite permission"
desc: string = "The overwrite permission to use, preceded by (/,-,+)"
Static optionalPermission
- optionalPermission(name?, desc?): IArg<Permission, boolean, false, EnumLike>
Parameters
name: string = "permissions"
desc: string = "The permission to use"
Static optionalReaction
- optionalReaction(name?, desc?): IArg<Reaction, boolean, false, EnumLike>
Parameters
name: string = "reaction emoji"
desc: string = "The reaction emoji to use"
Static optionalRole
- optionalRole(name?, desc?): IArg<Role, boolean, false, EnumLike>
Parameters
name: string = "role ID"
desc: string = "The role to use"
Static optionalRoleOrUser
- optionalRoleOrUser(name?, desc?): IArg<RoleOrUser, boolean, false, EnumLike>
Parameters
name: string = "role/user"
desc: string = "The role/user to use"
Static optionalScheduledEvent
- optionalScheduledEvent(name?, desc?): IArg<ScheduledEvent, boolean, false, EnumLike>
Parameters
name: string = "event ID"
desc: string = "The guild scheduled event to use"
Static optionalSoundboardSound
- optionalSoundboardSound(name?, desc?): IArg<SoundboardSound, boolean, false, EnumLike>
Parameters
name: string = "sound ID"
desc: string = "The soundboard sound to use"
Static optionalStageInstance
- optionalStageInstance(name?, desc?): IArg<StageInstance, boolean, false, EnumLike>
Parameters
name: string = "stage ID"
desc: string = "The stage instance to use"
Static optionalSticker
- optionalSticker(name?, desc?): IArg<Sticker, boolean, false, EnumLike>
Parameters
name: string = "sticker ID"
desc: string = "The sticker to use"
Static optionalString
- optionalString(name?, desc?): IArg<String, boolean, false, EnumLike>
Parameters
name: string = "string"
desc: string = "The string to use"
Static optionalTemplate
- optionalTemplate(name?, desc?): IArg<Template, boolean, false, EnumLike>
Parameters
name: string = "template code"
desc: string = "The template code to use"
Static optionalTextChannel
- optionalTextChannel(name?, desc?): IArg<TextChannel, boolean, false, EnumLike>
Parameters
name: string = "text channel ID"
desc: string = "The text channel to use"
Static optionalTime
- optionalTime(name?, desc?): IArg<Time, boolean, false, EnumLike>
Parameters
name: string = "duration/time"
desc: string = "The duration/time to use"
Static optionalURL
- optionalURL(name?, desc?): IArg<URL, boolean, false, EnumLike>
Parameters
name: string = "url"
desc: string = "The url to use"
Static optionalUser
- optionalUser(name?, desc?): IArg<User, boolean, false, EnumLike>
Parameters
name: string = "user ID"
desc: string = "The user to use"
Static optionalWebhook
- optionalWebhook(name?, desc?): IArg<Webhook, boolean, false, EnumLike>
Parameters
name: string = "webhook ID"
desc: string = "The webhook to use"
Static requiredApplicationEmoji
- requiredApplicationEmoji(name?, desc?): IArg<ApplicationEmoji, true, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The application emoji to use"
Static requiredAttachment
- requiredAttachment(name?, desc?): IArg<Attachment, true, false, EnumLike>
Parameters
name: string = "attachment"
desc: string = "The attachment to use"
Static requiredAutomodRule
- requiredAutomodRule(name?, desc?): IArg<AutomodRule, true, false, EnumLike>
Parameters
name: string = "rule ID"
desc: string = "The guild automod rule to use"
Static requiredBigInt
- requiredBigInt(name?, desc?): IArg<BigInt, true, false, EnumLike>
Parameters
name: string = "bigint"
desc: string = "The bigint to use"
Static requiredBoolean
- requiredBoolean(name?, desc?): IArg<Boolean, true, false, EnumLike>
Parameters
name: string = "bool"
desc: string = "The boolean to use"
Static requiredChannel
- requiredChannel(name?, desc?): IArg<Channel, boolean, true, EnumLike>
Parameters
name: string = "channel ID"
desc: string = "The channel to use"
Static requiredColor
- requiredColor(name?, desc?): IArg<Color, true, false, EnumLike>
Parameters
name: string = "color hex/int"
desc: string = "The color to use"
Static requiredDate
- requiredDate(name?, desc?): IArg<Date, true, false, EnumLike>
Parameters
name: string = "timestamp/date"
desc: string = "The timestamp/date to use"
Static requiredEmoji
- requiredEmoji(name?, desc?): IArg<Emoji, true, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The emoji to use"
Static requiredEnum
- requiredEnum<T>(en, name?, desc?): IArg<Enum, true, false, T>
Parameters
en: T
name: string = "enum value"
desc: string = "The enum values to use"
Returns IArg<Enum, true, false, T>
Static requiredGuild
- requiredGuild(name?, desc?): IArg<Guild, true, false, EnumLike>
Parameters
name: string = "guild ID"
desc: string = "The guild to use"
Static requiredGuildEmoji
- requiredGuildEmoji(name?, desc?): IArg<GuildEmoji, true, false, EnumLike>
Parameters
name: string = "emoji ID"
desc: string = "The guild emoji to use"
Static requiredInvite
- requiredInvite(name?, desc?): IArg<Invite, true, false, EnumLike>
Parameters
name: string = "invite code"
desc: string = "The invite code to use"
Static requiredJson
- requiredJson(name?, desc?): IArg<Json, true, false, EnumLike>
Parameters
name: string = "json data"
desc: string = "The JSON valid value to use"
Static requiredMember
- requiredMember(name?, desc?): IArg<Member, true, false, EnumLike>
Parameters
name: string = "member ID"
desc: string = "The guild member to use"
Static requiredMessage
- requiredMessage(name?, desc?): IArg<Message, true, false, EnumLike>
Parameters
name: string = "message ID"
desc: string = "The message to use"
Static requiredNumber
- requiredNumber(name?, desc?): IArg<Number, true, false, EnumLike>
Parameters
name: string = "number"
desc: string = "The number to use"
Static requiredOverwritePermission
- requiredOverwritePermission(name?, desc?): IArg<OverwritePermission, true, false, EnumLike>
Parameters
name: string = "overwrite permission"
desc: string = "The overwrite permission to use, preceded by (/,-,+)"
Static requiredPermission
- requiredPermission(name?, desc?): IArg<Permission, true, false, EnumLike>
Parameters
name: string = "permission"
desc: string = "The permission to use"
Static requiredReaction
- requiredReaction(name?, desc?): IArg<Reaction, true, false, EnumLike>
Parameters
name: string = "reaction emoji"
desc: string = "The reaction emoji to use"
Static requiredRole
- requiredRole(name?, desc?): IArg<Role, true, false, EnumLike>
Parameters
name: string = "role ID"
desc: string = "The role to use"
Static requiredRoleOrUser
- requiredRoleOrUser(name?, desc?): IArg<RoleOrUser, true, false, EnumLike>
Parameters
name: string = "role/user"
desc: string = "The role/user to use"
Static requiredScheduledEvent
- requiredScheduledEvent(name?, desc?): IArg<ScheduledEvent, true, false, EnumLike>
Parameters
name: string = "event ID"
desc: string = "The guild scheduled event to use"
Static requiredSoundboardSound
- requiredSoundboardSound(name?, desc?): IArg<SoundboardSound, true, false, EnumLike>
Parameters
name: string = "sound ID"
desc: string = "The soundboard sound to use"
Static requiredStageInstance
- requiredStageInstance(name?, desc?): IArg<StageInstance, true, false, EnumLike>
Parameters
name: string = "stage ID"
desc: string = "The stage instance to use"
Static requiredSticker
- requiredSticker(name?, desc?): IArg<Sticker, true, false, EnumLike>
Parameters
name: string = "sticker ID"
desc: string = "The sticker to use"
Static requiredString
- requiredString(name?, desc?): IArg<String, true, false, EnumLike>
Parameters
name: string = "string"
desc: string = "The string to use"
Static requiredTemplate
- requiredTemplate(name?, desc?): IArg<Template, true, false, EnumLike>
Parameters
name: string = "template code"
desc: string = "The template code to use"
Static requiredTextChannel
- requiredTextChannel(name?, desc?): IArg<TextChannel, true, false, EnumLike>
Parameters
name: string = "text channel ID"
desc: string = "The text channel to use"
Static requiredTime
- requiredTime(name?, desc?): IArg<Time, true, false, EnumLike>
Parameters
name: string = "duration/time"
desc: string = "The duration/time to use"
Static requiredURL
- requiredURL(name?, desc?): IArg<URL, true, false, EnumLike>
Parameters
name: string = "url"
desc: string = "The url to use"
Static requiredUser
- requiredUser(name?, desc?): IArg<User, true, false, EnumLike>
Parameters
name: string = "user ID"
desc: string = "The user to use"
Static requiredWebhook
- requiredWebhook(name?, desc?): IArg<Webhook, true, false, EnumLike>
Parameters
name: string = "webhook ID"
desc: string = "The webhook to use"
Static restApplicationEmoji
- restApplicationEmoji(name?, desc?, required?): IArg<ApplicationEmoji, boolean, true, EnumLike>
Parameters
name: string = "emoji IDs"
desc: string = "The application emojis to use"
required: boolean = false
Static restAttachment
- restAttachment(name?, desc?, required?): IArg<Attachment, boolean, true, EnumLike>
Parameters
name: string = "attachments"
desc: string = "The attachments to use"
required: boolean = false
Static restAutomodRule
- restAutomodRule(name?, desc?, required?): IArg<AutomodRule, boolean, true, EnumLike>
Parameters
name: string = "rule IDs"
desc: string = "The guild automod rule to use"
required: boolean = false
Static restBigInt
- restBigInt(name?, desc?, required?): IArg<BigInt, boolean, true, EnumLike>
Parameters
name: string = "bigints"
desc: string = "The bigints to use"
required: boolean = false
Static restBoolean
- restBoolean(name?, desc?, required?): IArg<Boolean, boolean, true, EnumLike>
Parameters
name: string = "bools"
desc: string = "The booleans to use"
required: boolean = false
Static restChannel
- restChannel(name?, desc?, required?): IArg<Channel, boolean, true, EnumLike>
Parameters
name: string = "channel IDs"
desc: string = "The channels to use"
required: boolean = false
Static restColor
- restColor(name?, desc?, required?): IArg<Color, boolean, true, EnumLike>
Parameters
name: string = "color hex/int(s)"
desc: string = "The colors to use"
required: boolean = false
Static restDate
- restDate(name?, desc?, required?): IArg<Date, boolean, true, EnumLike>
Parameters
name: string = "timestamp/date"
desc: string = "The timestamp/date to use"
required: boolean = false
Static restEmoji
- restEmoji(name?, desc?, required?): IArg<Emoji, boolean, true, EnumLike>
Parameters
name: string = "emoji IDs"
desc: string = "The emojis to use"
required: boolean = false
Static restEnum
- restEnum<T>(en, name?, desc?, required?): IArg<Enum, boolean, true, T>
Parameters
en: T
name: string = "enum values"
desc: string = "The enum values to use"
required: boolean = false
Returns IArg<Enum, boolean, true, T>
Static restGuild
- restGuild(name?, desc?, required?): IArg<Guild, boolean, true, EnumLike>
Parameters
name: string = "guild IDs"
desc: string = "The guilds to use"
required: boolean = false
Static restGuildEmoji
- restGuildEmoji(name?, desc?, required?): IArg<GuildEmoji, boolean, true, EnumLike>
Parameters
name: string = "emoji IDs"
desc: string = "The guild emojis to use"
required: boolean = false
Static restInvite
- restInvite(name?, desc?, required?): IArg<Invite, boolean, true, EnumLike>
Parameters
name: string = "invite codes"
desc: string = "The invite codes to use"
required: boolean = false
Static restJson
- restJson(name?, desc?, required?): IArg<Json, boolean, true, EnumLike>
Parameters
name: string = "json datas"
desc: string = "The JSON valid values to use"
required: boolean = false
Static restMember
- restMember(name?, desc?, required?): IArg<Member, boolean, true, EnumLike>
Parameters
name: string = "member IDs"
desc: string = "The guild members to use"
required: boolean = false
Static restMessage
- restMessage(name?, desc?, required?): IArg<Message, boolean, true, EnumLike>
Parameters
name: string = "message IDs"
desc: string = "The messages to use"
required: boolean = false
Static restNumber
- restNumber(name?, desc?, required?): IArg<Number, boolean, true, EnumLike>
Parameters
name: string = "numbers"
desc: string = "The numbers to use"
required: boolean = false
Static restOverwritePermission
- restOverwritePermission(name?, desc?, required?): IArg<OverwritePermission, boolean, true, EnumLike>
Parameters
name: string = "overwrite permissions"
desc: string = "The overwrite permissions to use, preceded by (/,-,+)"
required: boolean = false
Static restPermission
- restPermission(name?, desc?, required?): IArg<Permission, boolean, true, EnumLike>
Parameters
name: string = "permissions"
desc: string = "The permissions to use"
required: boolean = false
Static restReaction
- restReaction(name?, desc?, required?): IArg<Reaction, boolean, true, EnumLike>
Parameters
name: string = "reaction emojis"
desc: string = "The reaction emojis to use"
required: boolean = false
Static restRole
- restRole(name?, desc?, required?): IArg<Role, boolean, true, EnumLike>
Parameters
name: string = "role IDs"
desc: string = "The roles to use"
required: boolean = false
Static restRoleOrUser
- restRoleOrUser(name?, desc?, required?): IArg<RoleOrUser, boolean, true, EnumLike>
Parameters
name: string = "role/user(s)"
desc: string = "The role/user(s) to use"
required: boolean = false
Static restScheduledEvent
- restScheduledEvent(name?, desc?, required?): IArg<ScheduledEvent, boolean, true, EnumLike>
Parameters
name: string = "event IDs"
desc: string = "The guild scheduled events to use"
required: boolean = false
Static restSoundboardSound
- restSoundboardSound(name?, desc?, required?): IArg<SoundboardSound, boolean, true, EnumLike>
Parameters
name: string = "sound IDs"
desc: string = "The soundboard sounds to use"
required: boolean = false
Static restStageInstance
- restStageInstance(name?, desc?, required?): IArg<StageInstance, boolean, true, EnumLike>
Parameters
name: string = "stage IDs"
desc: string = "The stage instances to use"
required: boolean = false
Static restSticker
- restSticker(name?, desc?, required?): IArg<Sticker, boolean, true, EnumLike>
Parameters
name: string = "sticker IDs"
desc: string = "The stickers to use"
required: boolean = false
Static restString
- restString(name?, desc?, required?): IArg<String, boolean, true, EnumLike>
Parameters
name: string = "strings"
desc: string = "The strings to use"
required: boolean = false
Static restTemplate
- restTemplate(name?, desc?, required?): IArg<Template, boolean, true, EnumLike>
Parameters
name: string = "template codes"
desc: string = "The template codes to use"
required: boolean = false
Static restTextChannel
- restTextChannel(name?, desc?, required?): IArg<TextChannel, boolean, true, EnumLike>
Parameters
name: string = "text channel IDs"
desc: string = "The text channels to use"
required: boolean = false
Static restTime
- restTime(name?, desc?, required?): IArg<Time, boolean, true, EnumLike>
Parameters
name: string = "duration/time"
desc: string = "The duration/time to use"
required: boolean = false
Static restURL
- restURL(name?, desc?, required?): IArg<URL, boolean, true, EnumLike>
Parameters
name: string = "urls"
desc: string = "The urls to use"
required: boolean = false
Static restUser
- restUser(name?, desc?, required?): IArg<User, boolean, true, EnumLike>
Parameters
name: string = "user IDs"
desc: string = "The users to use"
required: boolean = false
Static restWebhook
- restWebhook(name?, desc?, required?): IArg<Webhook, boolean, true, EnumLike>
Parameters
name: string = "webhook IDs"
desc: string = "The webhooks to use"
required: boolean = false