Function: positional()

Call Signature

declare function positional<T>(parser: CombinatorSchema<T>): CombinatorSchema<T> & ArgSchemaPositionalType

WARNING

This API is experimental and may change in future versions.

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

Name	Description
T	The parser's resolved type.

Parameters

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

Returns

CombinatorSchema<T> & ArgSchemaPositionalType — A positional argument schema resolving to the parser's type.

Examples

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

Call Signature

declare function positional(parser?: BaseOptions): ArgSchema & ArgSchemaPositionalType

WARNING

This API is experimental and may change in future versions.

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

Name	Type	Description
parser	BaseOptions	Optional base options (description, short, required). (optional)

Returns

ArgSchema & ArgSchemaPositionalType — A positional argument schema resolving to string.

Examples

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