Skip to content

Interface: CombinatorOptions<T>

WARNING

This API is experimental and may change in future versions.

Options for the combinator factory function.

Extends

Signature

ts
interface CombinatorOptions<T> extends BaseOptions

Type Parameters

NameDescription
TThe parsed value type.

Properties

NameTypeDescription
metavar (optional)stringDisplay name hint for help text generation. Default: 'custom'
parse(value: string) => TThe parse function that converts a string to the desired type.

parse Parameters

NameTypeDescription
valuestringThe input string value.

parse Returns

T — The parsed value of type T.

Released under the MIT License.