Skip to content

gunshi / default / CommandExamplesFetcher

Type Alias: CommandExamplesFetcher()<G>

ts
type CommandExamplesFetcher<G> = (ctx) => Awaitable<string>;

Command examples fetcher.

Type Parameters

Type ParameterDefault type
G extends GunshiParams<any>DefaultGunshiParams

Parameters

ParameterTypeDescription
ctxReadonly<CommandContext<G>>A command context

Returns

Awaitable<string>

A fetched command examples.

Released under the MIT License.