Type Alias: CommandExamplesFetcher<G>
Command examples fetcher.
Signature
ts
export type CommandExamplesFetcher<G extends GunshiParamsConstraint = DefaultGunshiParams> = (ctx: Readonly<CommandContext<G>>) => Awaitable<string>Type Parameters
| Name | Description |
|---|---|
G extends GunshiParamsConstraint = DefaultGunshiParams | A type extending GunshiParams to specify the shape of command context. |
Parameters
| Name | Type | Description |
|---|---|---|
ctx | Readonly<CommandContext<G>> | A command context |
Returns
Awaitable<string> — A fetched command examples.