Skip to main content

Interface: ExtendedArgumentOptions<K>

deprecated ExtendedArgument is deprecated and will be removed in v3.0.0.

Type parameters

NameType
Kextends keyof ArgType

Hierarchy

  • Options

    โ†ณ ExtendedArgumentOptions

Properties

aliases

โ€ข Optional Readonly aliases: readonly string[]

The aliases for the piece.

default []

Inherited from

Argument.Options.aliases

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:674


baseArgument

โ€ข baseArgument: K

The name of the underlying argument whose value is used to compute the extended argument value; see ArgType for valid keys.

Defined in

projects/framework/src/lib/structures/ExtendedArgument.ts:100


enabled

โ€ข Optional Readonly enabled: boolean

Whether or not the piece should be enabled. If set to false, the piece will be unloaded.

default true

Inherited from

Argument.Options.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:417


name

โ€ข Optional Readonly name: string

The name for the piece.

default ''

Inherited from

Argument.Options.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:412