gunshi / default / CommandExamplesFetcher
Type Alias: CommandExamplesFetcher()<G>
ts
type CommandExamplesFetcher<G> = (ctx) => Awaitable<string>;Command examples fetcher.
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>
A fetched command examples.