Interface: CombinatorOptions<T>

Options for the combinator factory function.

Extends

• BaseOptions

Signature

export interface CombinatorOptions<T> extends BaseOptions

Type Parameters

Name	Description
T	The parsed value type.

Properties

Name	Type	Description
metavar (optional)	string	Display name hint for help text generation. Default: 'custom'
parse	(value: string) => T	The parse function that converts a string to the desired type. It is called synchronously, as ArgSchema.parse is: a promise that it returns becomes the value as is, and its rejection is not reported as an error.

parse Parameters

Name	Type	Description
value	string	The input string value.

parse Returns

T — The parsed value of type T.