Interface: RenderingOptions<G>
Rendering control options
Since
v0.27.0
Signature
ts
export interface RenderingOptions<G extends GunshiParamsConstraint = DefaultGunshiParams>Type Parameters
| Name | Description |
|---|---|
G extends GunshiParamsConstraint = DefaultGunshiParams | A type extending GunshiParams to specify the shape of render options. |
Properties
| Name | Type | Description |
|---|---|---|
header (optional) | ((ctx: Readonly<CommandContext<G>>) => Promise<string>) | null | Header rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer |
usage (optional) | ((ctx: Readonly<CommandContext<G>>) => Promise<string>) | null | Usage rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer |
validationErrors (optional) | ((ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>) | null | Validation errors rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer |