Class ArgumentTranslator

Translates BaseOptions, ChannelOptions, and LengthOptions into API-compatible ResultOptions. You should not need to use this class directly; use the opts member instead.

Index

Properties

data opts

Methods

autocomplete channelTypes choices clone desc get localDesc localName name range required suboptions

Properties

`Private` data

data: ResultOptions

Internally used to build and store translation result.

`Private` opts

opts: BaseOptions | ChannelOptions | LengthOptions

Internally stores provided argument data.

Methods

autocomplete

autocomplete(enabled?): void
Set whether to enable argument autocompletion.
Parameters
- Optional enabled: boolean
Returns void
- Defined in src/opts.ts:155

channelTypes

channelTypes(types?): void
Set the channel types supported by the channel argument.
Parameters
- Optional types: ("GuildText" | "DM" | "GuildVoice" | "GroupDM" | "GuildCategory" | "GuildAnnouncement" | "AnnouncementThread" | "PublicThread" | "PrivateThread" | "GuildStageVoice" | "GuildDirectory" | "GuildForum" | "GuildMedia" | "GuildNews" | "GuildNewsThread" | "GuildPublicThread" | "GuildPrivateThread")[]
Returns void
- Defined in src/opts.ts:149

choices

choices(choices?): void
Set the possible values of the argument.
Parameters
- Optional choices: string[] | number[]
Returns void
- Defined in src/opts.ts:119

clone

clone(): ArgumentTranslator
Clones this argument translator.

Returns ArgumentTranslator
- Defined in src/opts.ts:108

desc

desc(desc?): void
Set the description of the argument.
Parameters
- Optional desc: string
Returns void
- Defined in src/opts.ts:116

get

get(property): any
Get a property value from the argument.
Parameters
- property: "name" | "desc" | "localName" | "localDesc" | "req" | "channelTypes" | "range" | "choices" | "autocomplete"
Returns any
- Defined in src/opts.ts:158

localDesc

localDesc(descs?): void
Set the localized descriptions of the argument.
Parameters
- Optional descs: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>
Returns void
- Defined in src/opts.ts:146

localName

localName(names?): void
Set the localized names of the argument.
Parameters
- Optional names: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>
Returns void
- Defined in src/opts.ts:143

name

name(name?): void
Set the name of the argument.
Parameters
- Optional name: string
Returns void
- Defined in src/opts.ts:113

range

range(range?): void
Set the minimum and/or maximum values/lengths of the argument.
Parameters
- Optional range: [number?, number?]
Returns void
- Defined in src/opts.ts:124

required

required(required?): void
Set whether the argument is required.
Parameters
- Optional required: boolean
Returns void
- Defined in src/opts.ts:140

suboptions

suboptions(options?): void
Set the subarguments of the subcommand/subgroup.
Parameters
- Optional options: ArgumentTranslator[]
Returns void
- Defined in src/opts.ts:152

Class ArgumentTranslator

Index

Properties

Methods

Properties

Private data

Private opts

Methods

autocomplete

Parameters

Returns void

channelTypes

Parameters

Returns void

choices

Parameters

Returns void

clone

Returns ArgumentTranslator

desc

Parameters

Returns void

get

Parameters

Returns any

localDesc

Parameters

Returns void

localName

Parameters

Returns void

name

Parameters

Returns void

range

Parameters

Returns void

required

Parameters

Returns void

suboptions

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` data

`Private` opts