Command | /deps/cliffy.ts | lume@v2.4.2

Module

x/lume/deps/cliffy.ts>Command#helpOption

🔥 Static site generator for Deno 🦕

lumeland/lume

Very Popular

Latest

Row

CheckboxOptionSettings

CursorPositionOptions

DenoLandProviderOptions

GenericInputPromptOptions

GenericInputPromptSettings

GenericListKeys

GenericListOption

GenericListOptions

GenericListOptionSettings

GenericListSettings

GenericPromptKeys

GenericPromptOptions

GenericPromptSettings

GithubProviderOptions

NestLandProviderOptions

UpgradeCommandOptions

UpgradeOptions

ValidationErrorOptions

CheckboxValueSettings

CompleteHandlerResult

GenericListValueOptions

GenericListValueSettings

Tty

bel

tty

ElementCreationOptions

denoDomDisableQuerySelectorCodeGeneration

AnalyzeMetafileOptions

FormatMessagesOptions

Eta

FFFFlavoredFrontmatter

run

CFB

SSF

method Command.prototype.helpOption

Re-export

import { Command } from "https://deno.land/x/lume@v2.4.2/deps/cliffy.ts";

helpOption(enable: false): this

Disable help option.

helpOption(

flags: string,

desc?: string,

opts?: OptionOptions<Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand> & { global: true; },

): this

Set global help option.

helpOption(

flags: string,

desc?: string,

opts?: OptionOptions<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>,

): this

Set help option.

helpOption(

flags: string,

desc?: string,

opts?: ActionHandler<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>,

): this

Set help option.

Disable help option.

Parameters

enable: false

Returns

this

Set global help option.

Parameters

flags: string

The flags of the help option.

optional

desc: string

The description of the help option.

optional

opts: OptionOptions<Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand> & { global: true; }

Help option options.

Returns

this

Set help option.

Parameters

flags: string

The flags of the help option.

optional

desc: string

The description of the help option.

optional

opts: OptionOptions<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

Help option options.

Returns

this

Set help option.

Parameters

flags: string

The flags of the help option.

optional

desc: string

The description of the help option.

optional

opts: ActionHandler<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

The action of the help option.

Returns

this