Command

Defined in: packages/core/src/command.ts:112

A command.

Type Parameters

T

T extends Input = Input

Constructors

Constructor

new Command<T>(names, desc?, version?): Command<T>

Defined in: packages/core/src/command.ts:172

Creates a new command.

Parameters

names

string | string[]

The names (aliases).

desc?

string

The description.

version?

string

The version.

Returns

Command<T>

Properties

$allowSurpassArgLimit

$allowSurpassArgLimit: boolean = false

Defined in: packages/core/src/command.ts:144

If you should be able to surpass the amount of positional arguments defined in the input.

---

$allowUnknownOptions

$allowUnknownOptions: boolean = false

Defined in: packages/core/src/command.ts:140

If this command allows unknown options.

---

$children

$children: Map<string, CommandAlias<Input>>

Defined in: packages/core/src/command.ts:132

The children of this command.

---

$description

$description: string | undefined

Defined in: packages/core/src/command.ts:120

The description of this command.

---

$errorFn

$errorFn: ErrorFn<T> | undefined = undefined

Defined in: packages/core/src/command.ts:160

The error handler of this command.

---

$fn

$fn: ActionFn<T> | undefined = undefined

Defined in: packages/core/src/command.ts:152

The action function of this command.

---

$input

$input: T

Defined in: packages/core/src/command.ts:148

The input this command takes.

---

$middlewares

$middlewares: MiddlewareFn<T>[] = []

Defined in: packages/core/src/command.ts:156

The middlewares associated with this command.

---

$names

$names: string[]

Defined in: packages/core/src/command.ts:116

The names (aliases) of this command.

---

$parent

$parent: Command<any> | undefined

Defined in: packages/core/src/command.ts:136

The parent of this command.

---

$parser

$parser: Parser

Defined in: packages/core/src/command.ts:164

The argument parser to use.

---

$theme

$theme: Theme | undefined

Defined in: packages/core/src/command.ts:124

The theme of this command

---

$version

$version: string | undefined

Defined in: packages/core/src/command.ts:128

The version of this command.

Methods

action()

action(fn): this

Defined in: packages/core/src/command.ts:234

Sets the action function for this command.

Parameters

fn

ActionFn<T>

The action.

Returns

this

this

---

add()

add(…commands): this

Defined in: packages/core/src/command.ts:254

Adds existing commands to this.

Parameters

commands

…Command<any>[]

The commands.

Returns

this

this

---

alias()

alias(…aliases): this

Defined in: packages/core/src/command.ts:183

Adds a set of aliases to this command.

Parameters

aliases

…string[]

The aliases to add.

Returns

this

this

---

allowSurpassArgLimit()

allowSurpassArgLimit(): this

Defined in: packages/core/src/command.ts:445

Allows surpassing the amount of arguments specified.

Returns

this

this

---

allowUnknownOptions()

allowUnknownOptions(): this

Defined in: packages/core/src/command.ts:305

Allows unknown options.

Returns

this

this

---

buildInputMap()

buildInputMap(): Map<string | number, InputMapEntry>

Defined in: packages/core/src/command.ts:418

Returns

Map<string | number, InputMapEntry>

---

defaultErrorScreen()

defaultErrorScreen(errors): void

Defined in: packages/core/src/command.ts:469

The default error screen.

Parameters

errors

Error[]

The errors.

Returns

void

---

description()

description(desc): this

Defined in: packages/core/src/command.ts:194

Adds a description to this command.

Parameters

desc

string

The description.

Returns

this

this

---

error()

error(fn): this

Defined in: packages/core/src/command.ts:244

Sets the error function for this command.

Parameters

fn

ErrorFn<T>

The error handler.

Returns

this

this

---

fullCommandPath()

fullCommandPath(): string

Defined in: packages/core/src/command.ts:454

Gets the full command path (name including parents).

Returns

string

The full command path.

---

handleErrors()

handleErrors(errors, input?): Promise<Command<T>>

Defined in: packages/core/src/command.ts:570

Handles a set of errors.

Parameters

errors

Error[]

The errors to handle.

input?

Partial<InferInput<T>>

The parsed input, if possible.

Returns

Promise<Command<T>>

this

---

input()

input<TInput>(input): Command<TInput>

Defined in: packages/core/src/command.ts:214

Sets the input for this command.

Type Parameters

TInput

TInput extends Input

Parameters

input

TInput

The input.

Returns

Command<TInput>

this

---

parse()

parse(argv?): Promise<ValidatedParseResult<T>>

Defined in: packages/core/src/command.ts:315

Parses a set of command-line arguments.

Parameters

argv?

string[] = ...

The arguments to parse.

Returns

Promise<ValidatedParseResult<T>>

A validated parse result.

---

run()

run(argv?): Promise<Command<T>>

Defined in: packages/core/src/command.ts:593

Runs a command.

Parameters

argv?

string[] = ...

The arguments to run the command with. Defaults to your runtime’s argv equivalent.

Returns

Promise<Command<T>>

this

---

subCommand()

Call Signature

subCommand(names, builder): this

Defined in: packages/core/src/command.ts:271

Creates a new subcommand and adds it.

Parameters

names

string | string[]

The aliases of the subcommand.

builder

Builder

A builder to create the command.

Returns

this

Call Signature

subCommand(names, desc?, version?): Command<any>

Defined in: packages/core/src/command.ts:278

Creates a new subcommand and adds it.

Parameters

names

string | string[]

The aliases of the subcommand.

desc?

string

The description of the subcommand.

version?

string

The version of the subcommand.

Returns

Command<any>

---

use()

use(…fns): this

Defined in: packages/core/src/command.ts:224

Adds a chain of middlewares.

Parameters

fns

…MiddlewareFn<T>[]

The middlewares to use.

Returns

this

this

---

version()

version(version): this

Defined in: packages/core/src/command.ts:204

Adds a version to this command.

Parameters

version

string

The version.

Returns

this

this