Skip to main content

Class: NumberParam<Required>

Defined in: packages/bakit/src/core/structures/param/Param.ts:163

Extends​

Type Parameters​

Required​

Required extends boolean = true

Constructors​

Constructor​

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

Defined in: packages/bakit/src/core/structures/param/Param.ts:164

Parameters​

options​

string | { description?: string; maxValue?: number; minValue?: number; name: string; required?: boolean; }

Returns​

NumberParam<Required>

Overrides​

BaseParam.constructor

Properties​

_type​

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

Defined in: packages/bakit/src/core/structures/param/Param.ts:33

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/core/structures/param/Param.ts:23

Type Declaration​

description?​

optional description: string

maxValue?​

optional maxValue: number

minValue?​

optional minValue: number

name​

name: string

required?​

optional required: boolean

Type Declaration​

required​

required: Required

Inherited from​

BaseParam.options

Methods​

description()​

description(value): NumberParam<Required>

Defined in: packages/bakit/src/core/structures/param/Param.ts:74

Parameters​

value​

string

Returns​

NumberParam<Required>

Inherited from​

BaseParam.description

max()​

max(value): NumberParam<Required>

Defined in: packages/bakit/src/core/structures/param/Param.ts:208

Sets the maximum allowed value for this number. Pass null to remove this constraint.

Parameters​

value​

null | number

Returns​

NumberParam<Required>

min()​

min(value): NumberParam<Required>

Defined in: packages/bakit/src/core/structures/param/Param.ts:200

Sets the minimum allowed value for this number. Pass null to remove this constraint.

Parameters​

value​

null | number

Returns​

NumberParam<Required>

name()​

name(value): NumberParam<Required>

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

Parameters​

value​

string

Returns​

NumberParam<Required>

Inherited from​

BaseParam.name

required()​

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

Defined in: packages/bakit/src/core/structures/param/Param.ts:168

Type Parameters​

V​

V extends boolean

Parameters​

value​

V

Returns​

NumberParam<V>

Overrides​

BaseParam.required

resolve()​

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

Defined in: packages/bakit/src/core/structures/param/Param.ts:82

Parameters​

context​

CommandContext

value?​

string

Returns​

Promise<ParamResolvedOutputType<number, Required>>

Inherited from​

BaseParam.resolve

resolveChatInput()​

resolveChatInput(context): ParamResolvedOutputType<number, Required>

Defined in: packages/bakit/src/core/structures/param/Param.ts:191

Parameters​

context​

ChatInputContext

Returns​

ParamResolvedOutputType<number, Required>

Overrides​

BaseParam.resolveChatInput

resolveMessage()​

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

Defined in: packages/bakit/src/core/structures/param/Param.ts:172

Parameters​

_context​

CommandContext

value​

string

Returns​

ParamResolvedOutputType<number, Required>

Overrides​

BaseParam.resolveMessage