Function: boolean()

WARNING

This API is experimental and may change in future versions.

Create a boolean argument schema.

Boolean arguments are existence-based. The resolver passes "true" or "false" to the parse function based on the presence or negation of the flag.

Signature

declare function boolean(opts?: BooleanOptions): CombinatorSchema<boolean>

Parameters

Name	Type	Description
opts	BooleanOptions	Boolean options. (optional)

Returns

CombinatorSchema<boolean> — A combinator schema for boolean flags.

Examples

const args = {
  color: boolean({ negatable: true })
}
// Usage: --color (true), --no-color (false)