Skip to main content

Abstract Class: BaseParam<Options, OutputType, Required>

Defined in: packages/bakit/src/command/param/Param.ts:10

Extended by​

Type Parameters​

Options​

Options extends BaseParamOptions

OutputType​

OutputType

Required​

Required extends boolean = true

Constructors​

Constructor​

new BaseParam<Options, OutputType, Required>(options): BaseParam<Options, OutputType, Required>

Defined in: packages/bakit/src/command/param/Param.ts:23

Parameters​

options​

Options

Returns​

BaseParam<Options, OutputType, Required>

Properties​

_type​

readonly _type: Required extends true ? OutputType : null | OutputType

Defined in: packages/bakit/src/command/param/Param.ts:21

Internal

Internal Phantom Type

Used strictly for TypeScript type inference to determine the runtime value of this parameter. This property does not exist at runtime.

options​

options: Options & object

Defined in: packages/bakit/src/command/param/Param.ts:11

Type Declaration​

required​

required: Required

Methods​

description()​

description(value): BaseParam<Options, OutputType, Required>

Defined in: packages/bakit/src/command/param/Param.ts:45

Parameters​

value​

string

Returns​

BaseParam<Options, OutputType, Required>

name()​

name(value): BaseParam<Options, OutputType, Required>

Defined in: packages/bakit/src/command/param/Param.ts:41

Parameters​

value​

string

Returns​

BaseParam<Options, OutputType, Required>

required()​

required<V>(value): BaseParam<Options, OutputType, V>

Defined in: packages/bakit/src/command/param/Param.ts:49

Type Parameters​

V​

V extends boolean

Parameters​

value​

V

Returns​

BaseParam<Options, OutputType, V>

resolve()​

resolve(context, value?): Promise<ParamResolvedOutputType<OutputType, Required>>

Defined in: packages/bakit/src/command/param/Param.ts:53

Parameters​

context​

CommandContext

value?​

string

Returns​

Promise<ParamResolvedOutputType<OutputType, Required>>

resolveChatInput()​

abstract resolveChatInput(context): Awaitable<ParamResolvedOutputType<OutputType, Required>>

Defined in: packages/bakit/src/command/param/Param.ts:70

Parameters​

context​

ChatInputContext

Returns​

Awaitable<ParamResolvedOutputType<OutputType, Required>>

resolveMessage()​

abstract resolveMessage(context, value): Awaitable<ParamResolvedOutputType<OutputType, Required>>

Defined in: packages/bakit/src/command/param/Param.ts:66

Parameters​

context​

MessageContext

value​

undefined | string

Returns​

Awaitable<ParamResolvedOutputType<OutputType, Required>>