Skip to main content Link Search Menu Expand Document (external link)

BuiltInOptions.ts overview

Since v1.0.0


Exports Grouped by Category


constructors

showCompletions

Signature

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

Source

Since v1.0.0

showHelp

Signature

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

Source

Since v1.0.0

showVersion

Signature

declare const showVersion: BuiltInOptions

Source

Since v1.0.0

showWizard

Signature

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

Source

Since v1.0.0

models

BuiltInOptions (type alias)

Signature

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

Source

Since v1.0.0

SetLogLevel (interface)

Signature

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

Source

Since v1.0.0

ShowCompletions (interface)

Signature

export interface ShowCompletions {
  readonly _tag: "ShowCompletions"
  readonly shellType: BuiltInOptions.ShellType
}

Source

Since v1.0.0

ShowHelp (interface)

Signature

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

Source

Since v1.0.0

ShowVersion (interface)

Signature

export interface ShowVersion {
  readonly _tag: "ShowVersion"
}

Source

Since v1.0.0

ShowWizard (interface)

Signature

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

Source

Since v1.0.0

options

builtInOptions

Signature

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

Source

Since v1.0.0

refinements

isShowCompletions

Signature

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

Source

Since v1.0.0

isShowHelp

Signature

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

Source

Since v1.0.0

isShowVersion

Signature

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

Source

Since v1.0.0

isShowWizard

Signature

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

Source

Since v1.0.0

utils

BuiltInOptions (namespace)

Source

Since v1.0.0

ShellType (type alias)

Signature

type ShellType = "bash" | "fish" | "zsh"

Source

Since v1.0.0