gunshi / combinators / short

Function: short()

function short<T, S>(schema, alias): ArgSchema & Combinator<T> & CombinatorShort<S>;

Experimental

Set a short alias on a combinator schema.

The original schema is not modified.

Type Parameters

Type Parameter	Description
T	The schema's parsed type.
S extends string	The short alias string literal type.

Parameters

Parameter	Type	Description
schema	CombinatorSchema<T>	The base combinator schema.
alias	S	Single character short alias.

Returns

ArgSchema & Combinator<T> & CombinatorShort<S>

A new schema with the short alias set.

Example

const args = {
  verbose: short(boolean(), 'v')
}
// Usage: -v or --verbose