Skip to main content

Class: StringParam<Required>

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

Extends​

Type Parameters​

Required​

Required extends boolean = true

Constructors​

Constructor​

new StringParam<Required>(options): StringParam<Required>

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

Parameters​

options​

string | { description?: string; maxLength?: number; minLength?: number; name: string; required?: boolean; }

Returns​

StringParam<Required>

Overrides​

BaseParam.constructor

Properties​

_type​

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

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.

Inherited from​

BaseParam._type

options​

options: object & object

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

Type Declaration​

description?​

optional description: string

maxLength?​

optional maxLength: number

minLength?​

optional minLength: number

name​

name: string

required?​

optional required: boolean

Type Declaration​

required​

required: Required

Inherited from​

BaseParam.options

Methods​

description()​

description(value): StringParam<Required>

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

Parameters​

value​

string

Returns​

StringParam<Required>

Inherited from​

BaseParam.description

max()​

max(length): StringParam<Required>

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

Sets the maximum allowed length for this string. Pass null to remove this constraint.

Parameters​

length​

null | number

Returns​

StringParam<Required>

min()​

min(length): StringParam<Required>

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

Sets the minimum allowed length for this string. Pass null to remove this constraint.

Parameters​

length​

null | number

Returns​

StringParam<Required>

name()​

name(value): StringParam<Required>

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

Parameters​

value​

string

Returns​

StringParam<Required>

Inherited from​

BaseParam.name

required()​

required<V>(value): StringParam<V>

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

Type Parameters​

V​

V extends boolean

Parameters​

value​

V

Returns​

StringParam<V>

Overrides​

BaseParam.required

resolve()​

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

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

Parameters​

context​

CommandContext

value?​

string

Returns​

Promise<ParamResolvedOutputType<string, Required>>

Inherited from​

BaseParam.resolve

resolveChatInput()​

resolveChatInput(context): ParamResolvedOutputType<string, Required>

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

Parameters​

context​

ChatInputContext

Returns​

ParamResolvedOutputType<string, Required>

Overrides​

BaseParam.resolveChatInput

resolveMessage()​

resolveMessage(_context, value): ParamResolvedOutputType<string, Required>

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

Parameters​

_context​

CommandContext

value​

undefined | string

Returns​

ParamResolvedOutputType<string, Required>

Overrides​

BaseParam.resolveMessage