Skip to main content

Class: Command<ParamsList>

Defined in: packages/bakit/src/command/Command.ts:28

The command entry, used for registering command.

Extends​

Type Parameters​

ParamsList​

ParamsList extends readonly AnyParam<any>[] = any[]

Constructors​

Constructor​

new Command<ParamsList>(options): Command<ParamsList>

Defined in: packages/bakit/src/command/Command.ts:34

Parameters​

options​

string | Omit<{ description?: string; name: string; params?: BaseParam<{ description?: string; name: string; required?: boolean; }, unknown, boolean>[]; quotes?: boolean; }, "params"> & object

Returns​

Command<ParamsList>

Overrides​

LifecycleManager.constructor

Properties​

id​

id: string

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:36

Inherited from​

LifecycleManager.id

options​

options: object

Defined in: packages/bakit/src/command/Command.ts:32

description​

description: string

name​

name: string

params​

params: BaseParam<{ description?: string; name: string; required?: boolean; }, unknown, boolean>[]

quotes​

quotes: boolean

Methods​

error()​

error(callback): Command<ParamsList>

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:83

Parameters​

callback​

ErrorHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

Returns​

Command<ParamsList>

Inherited from​

LifecycleManager.error

execute()​

execute(context, ...args): Promise<void>

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:87

Parameters​

context​

CommandContext

args​

...[...args: InferParamTuple<ParamsList>[]]

Returns​

Promise<void>

Inherited from​

LifecycleManager.execute

getName()​

getName(name): string

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:38

Parameters​

name​

string

Returns​

string

Inherited from​

LifecycleManager.getName

main()​

main(callback): Command<ParamsList>

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:71

Parameters​

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

Returns​

Command<ParamsList>

Inherited from​

LifecycleManager.main

post()​

post(callback): Command<ParamsList>

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:79

Parameters​

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

Returns​

Command<ParamsList>

Inherited from​

LifecycleManager.post

pre()​

pre(callback): Command<ParamsList>

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:75

Parameters​

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

Returns​

Command<ParamsList>

Inherited from​

LifecycleManager.pre

setHook()​

Call Signature​

setHook(name, state, callback, order?): this

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:42

Parameters​
name​

string

state​

Post

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

order?​

HookOrder

Returns​

this

Inherited from​

LifecycleManager.setHook

Call Signature​

setHook(name, state, callback, order?): this

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:43

Parameters​
name​

string

state​

Main

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

order?​

HookOrder

Returns​

this

Inherited from​

LifecycleManager.setHook

Call Signature​

setHook(name, state, callback, order?): this

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:44

Parameters​
name​

string

state​

Pre

callback​

MainHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

order?​

HookOrder

Returns​

this

Inherited from​

LifecycleManager.setHook

Call Signature​

setHook(name, state, callback, order?): this

Defined in: packages/bakit/src/base/lifecycle/LifecycleManager.ts:45

Parameters​
name​

string

state​

Error

callback​

ErrorHookCallback<CommandContext, [...args: InferParamTuple<ParamsList>[]]>

order?​

HookOrder

Returns​

this

Inherited from​

LifecycleManager.setHook