BuiltInOptions
Constructors
showCompletions
Added in v1.0.0
Source
Signature
declare const showCompletions: (shellType: BuiltInOptions.ShellType) => BuiltInOptionsSignature
declare const showHelp: (usage: Usage, helpDoc: HelpDoc) => BuiltInOptionsshowVersion
Added in v1.0.0
Source
Signature
declare const showVersion: BuiltInOptionsshowWizard
Added in v1.0.0
Source
Signature
declare const showWizard: (command: Command<unknown>) => BuiltInOptionsModels
BuiltInOptions type
Added in v1.0.0
Source
Signature
type BuiltInOptions = SetLogLevel | ShowHelp | ShowCompletions | ShowWizard | ShowVersionSetLogLevel 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;}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
builtInOptions
Added in v1.0.0
Source
Signature
declare const builtInOptions: <A>(command: Command<A>, usage: Usage, helpDoc: HelpDoc) => Options<Option<BuiltInOptions>>Other
BuiltInOptions
Added in v1.0.0
Source
Refinements
isShowCompletions
Added in v1.0.0
Source
Signature
declare const isShowCompletions: (self: BuiltInOptions) => self is ShowCompletionsisShowHelp
Added in v1.0.0
Source
Signature
declare const isShowHelp: (self: BuiltInOptions) => self is ShowHelpisShowVersion
Added in v1.0.0
Source
Signature
declare const isShowVersion: (self: BuiltInOptions) => self is ShowVersionisShowWizard
Added in v1.0.0
Source
Signature
declare const isShowWizard: (self: BuiltInOptions) => self is ShowWizard