BuiltInOptions.ts overview
Since v1.0.0
Exports Grouped by Category
constructors
showCompletions
Signature
declare const showCompletions: (shellType: BuiltInOptions.ShellType) => BuiltInOptions
Since v1.0.0
showHelp
Signature
declare const showHelp: (usage: Usage, helpDoc: HelpDoc) => BuiltInOptions
Since v1.0.0
showVersion
Signature
declare const showVersion: BuiltInOptions
Since v1.0.0
showWizard
Signature
declare const showWizard: (command: Command<unknown>) => BuiltInOptions
Since v1.0.0
models
BuiltInOptions (type alias)
Signature
type BuiltInOptions = SetLogLevel | ShowHelp | ShowCompletions | ShowWizard | ShowVersion
Since v1.0.0
SetLogLevel (interface)
Signature
export interface SetLogLevel {
readonly _tag: "SetLogLevel"
readonly level: LogLevel
}
Since v1.0.0
ShowCompletions (interface)
Signature
export interface ShowCompletions {
readonly _tag: "ShowCompletions"
readonly shellType: BuiltInOptions.ShellType
}
Since v1.0.0
ShowHelp (interface)
Signature
export interface ShowHelp {
readonly _tag: "ShowHelp"
readonly usage: Usage
readonly helpDoc: HelpDoc
}
Since v1.0.0
ShowVersion (interface)
Signature
export interface ShowVersion {
readonly _tag: "ShowVersion"
}
Since v1.0.0
ShowWizard (interface)
Signature
export interface ShowWizard {
readonly _tag: "ShowWizard"
readonly command: Command<unknown>
}
Since v1.0.0
options
builtInOptions
Signature
declare const builtInOptions: <A>(
command: Command<A>,
usage: Usage,
helpDoc: HelpDoc
) => Options<Option<BuiltInOptions>>
Since v1.0.0
refinements
isShowCompletions
Signature
declare const isShowCompletions: (self: BuiltInOptions) => self is ShowCompletions
Since v1.0.0
isShowHelp
Signature
declare const isShowHelp: (self: BuiltInOptions) => self is ShowHelp
Since v1.0.0
isShowVersion
Signature
declare const isShowVersion: (self: BuiltInOptions) => self is ShowVersion
Since v1.0.0
isShowWizard
Signature
declare const isShowWizard: (self: BuiltInOptions) => self is ShowWizard
Since v1.0.0
utils
BuiltInOptions (namespace)
Since v1.0.0
ShellType (type alias)
Signature
type ShellType = "bash" | "fish" | "zsh"
Since v1.0.0