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

method Command.prototype.helpOption

Re-export

import { Command } from "https://deno.land/x/lume@v2.4.1/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