Skip to content

BuiltInOptions

16 exports Added in v1.0.0 Source

Constructors

Signature

declare const showCompletions: (shellType: BuiltInOptions.ShellType) => BuiltInOptions;

showHelp

Added in v1.0.0 Source

Signature

declare const showHelp: (usage: Usage, helpDoc: HelpDoc) => BuiltInOptions;

showVersion

Added in v1.0.0 Source

Signature

declare const showVersion: BuiltInOptions;

showWizard

Added in v1.0.0 Source

Signature

declare const showWizard: (command: Command<unknown>) => BuiltInOptions;

Models

BuiltInOptions type

Added in v1.0.0 Source

Signature

type BuiltInOptions = SetLogLevel | ShowHelp | ShowCompletions | ShowWizard | ShowVersion;

SetLogLevel interface

Added in v1.0.0 Source

Signature

interface SetLogLevel {
  readonly _tag: "SetLogLevel";
  readonly level: LogLevel;
}

ShowCompletions interface

Added in v1.0.0 Source

Signature

interface ShowCompletions {
  readonly _tag: "ShowCompletions";
  readonly shellType: ShellType;
}

ShowHelp interface

Added in v1.0.0 Source

Signature

interface ShowHelp {
  readonly _tag: "ShowHelp";
  readonly helpDoc: HelpDoc;
  readonly usage: Usage;
}

ShowVersion interface

Added in v1.0.0 Source

Signature

interface ShowVersion {
  readonly _tag: "ShowVersion";
}

ShowWizard interface

Added in v1.0.0 Source

Signature

interface ShowWizard {
  readonly _tag: "ShowWizard";
  readonly command: Command<unknown>;
}

Options

Signature

declare const builtInOptions: <A>(
  command: Command<A>,
  usage: Usage,
  helpDoc: HelpDoc,
) => Options<Option<BuiltInOptions>>;

Other

Refinements

Signature

declare const isShowCompletions: (self: BuiltInOptions) => self is ShowCompletions;

isShowHelp

Added in v1.0.0 Source

Signature

declare const isShowHelp: (self: BuiltInOptions) => self is ShowHelp;

Signature

declare const isShowVersion: (self: BuiltInOptions) => self is ShowVersion;

isShowWizard

Added in v1.0.0 Source

Signature

declare const isShowWizard: (self: BuiltInOptions) => self is ShowWizard;