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

BuiltInOptions overview

Added in v1.0.0


Table of contents


constructors

showCompletions

Signature

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

Added in v1.0.0

showHelp

Signature

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

Added in v1.0.0

showVersion

Signature

export declare const showVersion: BuiltInOptions

Added in v1.0.0

showWizard

Signature

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

Added in v1.0.0

models

BuiltInOptions (type alias)

Signature

export type BuiltInOptions = ShowHelp | ShowCompletions | ShowWizard | ShowVersion

Added in v1.0.0

ShowCompletions (interface)

Signature

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

Added in v1.0.0

ShowHelp (interface)

Signature

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

Added in v1.0.0

ShowVersion (interface)

Signature

export interface ShowVersion {
  readonly _tag: "ShowVersion"
}

Added in v1.0.0

ShowWizard (interface)

Signature

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

Added in v1.0.0

options

builtInOptions

Signature

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

Added in v1.0.0

refinements

isShowCompletions

Signature

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

Added in v1.0.0

isShowHelp

Signature

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

Added in v1.0.0

isShowVersion

Signature

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

Added in v1.0.0

isShowWizard

Signature

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

Added in v1.0.0

utils

BuiltInOptions (namespace)

Added in v1.0.0

ShellType (type alias)

Signature

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

Added in v1.0.0