Usage
Combinators
alternation
Added in v1.0.0
Source
Signature
declare const alternation: { (that: Usage): (self: Usage) => Usage; (self: Usage, that: Usage): Usage;}Signature
declare const concat: { (that: Usage): (self: Usage) => Usage; (self: Usage, that: Usage): Usage;}Signature
declare const getHelp: (self: Usage) => HelpDocSignature
declare const optional: (self: Usage) => UsageSignature
declare const repeated: (self: Usage) => UsageConstructors
Signature
declare const empty: UsageSignature
declare const enumerate: { (config: CliConfig): (self: Usage) => Array<Span>; (self: Usage, config: CliConfig): Array<Span>;}Signature
declare const mixed: UsageSignature
declare const named: (names: ReadonlyArray<string>, acceptedValues: Option<string>) => UsageModels
Alternation interface
Added in v1.0.0
Source
Signature
interface Alternation { readonly _tag: "Alternation"; readonly left: Usage; readonly right: Usage;}Signature
interface Concat { readonly _tag: "Concat"; readonly left: Usage; readonly right: Usage;}Signature
interface Empty { readonly _tag: "Empty";}Signature
interface Mixed { readonly _tag: "Mixed";}Signature
interface Named { readonly _tag: "Named"; readonly acceptedValues: Option<string>; readonly names: readonly Array<string>;}Signature
interface Optional { readonly _tag: "Optional"; readonly usage: Usage;}Signature
interface Repeated { readonly _tag: "Repeated"; readonly usage: Usage;}Signature
type Usage = Empty | Mixed | Named | Optional | Repeated | Alternation | Concat