gunshi / combinators / positional

Function: positional()

Call Signature

function positional<T>(parser): ArgSchema & Combinator<T> & ArgSchemaPositionalType;

Experimental

Create a positional argument schema.

Without a parser, resolves to string. With a parser (e.g., positional(integer())), resolves to the parser's return type.

Type Parameters

Type Parameter	Description
T	The parser's resolved type.

Parameters

Parameter	Type	Description
parser	CombinatorSchema<T>	The parser combinator schema.

Returns

ArgSchema & Combinator<T> & ArgSchemaPositionalType

A positional argument schema resolving to the parser's type.

Example

const args = {
  command: positional(),           // resolves to string
  port: positional(integer()),     // resolves to number
}

Call Signature

function positional(parser?): ArgSchema & ArgSchemaPositionalType;

Experimental

Create a positional argument schema.

Without a parser, resolves to string. With a parser (e.g., positional(integer())), resolves to the parser's return type.

Parameters

Parameter	Type	Description
parser?	BaseOptions	Optional base options (description, short, required).

Returns

ArgSchema & ArgSchemaPositionalType

A positional argument schema resolving to string.

Example

const args = {
  command: positional(),           // resolves to string
  port: positional(integer()),     // resolves to number
}