cliffy.Command | /deps.ts | alloy_folk@v1.1.1

method cliffy.Command.prototype.helpOption

Re-export

import { cliffy } from "https://deno.land/x/alloy_folk@v1.1.1/deps.ts";
const { Command } = cliffy;

helpOption(enable: false): this

Disable help option.

helpOption(

flags: string,

desc?: string,

opts?: ICommandOption<Partial<CO>, CA, CG, CPG, CT, CGT, CPT, CP> & { global: true; },

): this

Set global help option.

helpOption(

flags: string,

desc?: string,

opts?: ICommandOption<CO, CA, CG, CPG, CT, CGT, CPT, CP>,

): this

Set help option.

helpOption(

flags: string,

desc?: string,

opts?: IAction<CO, CA, CG, CPG, CT, CGT, CPT, CP>,

): 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: ICommandOption<Partial<CO>, CA, CG, CPG, CT, CGT, CPT, CP> & { 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: ICommandOption<CO, CA, CG, CPG, CT, CGT, CPT, CP>

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: IAction<CO, CA, CG, CPG, CT, CGT, CPT, CP>

The action of the help option.

Returns

this