gunshi / combinators / CombinatorOptions
Interface: CombinatorOptions<T>
Experimental
Options for the combinator factory function.
Extends
Type Parameters
| Type Parameter | Description |
|---|---|
T | The parsed value type. |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
description? | string | Experimental Human-readable description for help text generation. | BaseOptions.description |
metavar? | string | Experimental Display name hint for help text generation. Default 'custom' | - |
parse | (value) => T | Experimental The parse function that converts a string to the desired type. | - |
required? | boolean | Experimental Mark as required. | BaseOptions.required |
short? | string | Experimental Single character short alias. | BaseOptions.short |