Skip to content

gunshi / default / RenderingOptions

Interface: RenderingOptions<G>

Rendering control options

Since

v0.27.0

Type Parameters

Type ParameterDefault type
G extends GunshiParamsConstraintDefaultGunshiParams

Properties

PropertyTypeDescription
header?null | (ctx) => Promise<string>Header rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer
usage?null | (ctx) => Promise<string>Usage rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer
validationErrors?null | (ctx, error) => Promise<string>Validation errors rendering configuration - null: Disable rendering - function: Use custom renderer - undefined (when omitted): Use default renderer

Released under the MIT License.