Skip to main content

Module: example

Classes

Type Aliases

ExampleConfig

Ƭ ExampleConfig: Object

Type declaration

NameTypeDescription
description?stringDescription of the example. This will appear as a title above the input/output line(s).
input?stringInput of the example. This will appear as a line below the description, with a $ prefix. The prefix can be changed using the help() function on the command.
output?stringOutput of the example. This will appear as a line below the input, with a > prefix. The prefix can be changed using the help() function on the command.

Defined in

src/example.ts:4

src/example.ts:18

Variables

ExampleConfig

Const ExampleConfig: ZodObject<ExampleConfig>

Defined in

src/example.ts:4

src/example.ts:18