Skip to main content

Module: command

Classes

Type Aliases

CommandConfig

Ƭ CommandConfig<RunArgs>: z.infer<ReturnType<typeof CommandConfig>>

Type parameters

NameType
RunArgsextends ArgsObject = ArgsObject

Defined in

src/command.ts:18

src/command.ts:37


ArgsObject

Ƭ ArgsObject: Record<string | number | symbol, any>

An object with string keys and any values.

Defined in

src/command.ts:44


Runner

Ƭ Runner<Args>: (options: Args, instance: MassargCommand<Args>) => Promise<void> | void

Type parameters

NameType
Argsextends ArgsObject

Type declaration

▸ (options, instance): Promise<void> | void

Parameters
NameType
optionsArgs
instanceMassargCommand<Args>
Returns

Promise<void> | void

Defined in

src/command.ts:46


ErrorHandler

Ƭ ErrorHandler: (error: Error) => void

Error handler callback type. Called when an error occurs during parsing or command execution.

Type declaration

▸ (error): void

Parameters
NameType
errorError
Returns

void

Defined in

src/command.ts:55

Functions

CommandConfig

CommandConfig<RunArgs>(_args): ZodObject<{ name: ZodString ; description: ZodString ; aliases: ZodOptional<ZodArray<ZodString>> ; run: ZodType<Runner<RunArgs>, unknown, $ZodTypeInternals<Runner<RunArgs>, unknown>> ; optionPrefix: ZodOptional<ZodDefault<ZodString>> ; aliasPrefix: ZodOptional<ZodDefault<ZodString>> }, $strip>

Type parameters

NameType
RunArgsextends ArgsObject = ArgsObject

Parameters

NameType
_argsZodType<RunArgs, unknown, $ZodTypeInternals<RunArgs, unknown>>

Returns

ZodObject<{ name: ZodString ; description: ZodString ; aliases: ZodOptional<ZodArray<ZodString>> ; run: ZodType<Runner<RunArgs>, unknown, $ZodTypeInternals<Runner<RunArgs>, unknown>> ; optionPrefix: ZodOptional<ZodDefault<ZodString>> ; aliasPrefix: ZodOptional<ZodDefault<ZodString>> }, $strip>

Defined in

src/command.ts:18