gunshi / default / CommandRunner
Type Alias: CommandRunner()<G>
ts
type CommandRunner<G> = (ctx) => Awaitable<string | void>;Command runner.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
G extends GunshiParamsConstraint | DefaultGunshiParams | A type extending GunshiParams to specify the shape of command context. |
Parameters
| Parameter | Type | Description |
|---|---|---|
ctx | Readonly<CommandContext<G>> | A command context |
Returns
Awaitable<string | void>
void or string (for CLI output)