Skip to content

Function: renderUsage()

Render the usage.

Signature

ts
declare function renderUsage<G extends GunshiParams = DefaultGunshiParams>(ctx: Readonly<CommandContext<G>>): Promise<string>

Type Parameters

Name
G extends GunshiParams = DefaultGunshiParams

Parameters

NameTypeDescription
ctxReadonly<CommandContext<G>>A command context

Returns

Promise<string> — A rendered usage.

Released under the MIT License.