Skip to content

Usage

17 exports Added in v1.0.0 Source

Combinators

alternation

Added in v1.0.0 Source

Signature

declare const alternation: {
  (that: Usage): (self: Usage) => Usage;
  (self: Usage, that: Usage): Usage;
};

concat

Added in v1.0.0 Source

Signature

declare const concat: {
  (that: Usage): (self: Usage) => Usage;
  (self: Usage, that: Usage): Usage;
};

getHelp

Added in v1.0.0 Source

Signature

declare const getHelp: (self: Usage) => HelpDoc;

optional

Added in v1.0.0 Source

Signature

declare const optional: (self: Usage) => Usage;

repeated

Added in v1.0.0 Source

Signature

declare const repeated: (self: Usage) => Usage;

Constructors

empty

Added in v1.0.0 Source

Signature

declare const empty: Usage;

enumerate

Added in v1.0.0 Source

Signature

declare const enumerate: {
  (config: CliConfig): (self: Usage) => Array<Span>;
  (self: Usage, config: CliConfig): Array<Span>;
};

mixed

Added in v1.0.0 Source

Signature

declare const mixed: Usage;

named

Added in v1.0.0 Source

Signature

declare const named: (names: ReadonlyArray<string>, acceptedValues: Option<string>) => Usage;

Models

Alternation interface

Added in v1.0.0 Source

Signature

interface Alternation {
  readonly _tag: "Alternation";
  readonly left: Usage;
  readonly right: Usage;
}

Concat interface

Added in v1.0.0 Source

Signature

interface Concat {
  readonly _tag: "Concat";
  readonly left: Usage;
  readonly right: Usage;
}

Empty interface

Added in v1.0.0 Source

Signature

interface Empty {
  readonly _tag: "Empty";
}

Mixed interface

Added in v1.0.0 Source

Signature

interface Mixed {
  readonly _tag: "Mixed";
}

Named interface

Added in v1.0.0 Source

Signature

interface Named {
  readonly _tag: "Named";
  readonly acceptedValues: Option<string>;
  readonly names: readonly Array<string>;
}

Optional interface

Added in v1.0.0 Source

Signature

interface Optional {
  readonly _tag: "Optional";
  readonly usage: Usage;
}

Repeated interface

Added in v1.0.0 Source

Signature

interface Repeated {
  readonly _tag: "Repeated";
  readonly usage: Usage;
}

Usage type

Added in v1.0.0 Source

Signature

type Usage = Empty | Mixed | Named | Optional | Repeated | Alternation | Concat;