Command | /command/command.ts | cliffy@v0.19.0

Module

x/cliffy/command/command.ts>Command#helpOption

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...

c4spar/deno-cliffy

Extremely Popular

Go to Latest

assets completions help test types upgrade

mod.ts (default module)

ValidationErrorOptions

CompleteHandlerResult

dim

red

CompleteHandlerResult

method Command.prototype.helpOption

import { Command } from "https://deno.land/x/cliffy@v0.19.0/command/command.ts";

helpOption(enable: false): this

Disable help option.

helpOption(

flags: string,

desc?: string,

opts?: ICommandOption<Partial<CO>, CA, CG, PG, P> & { global: true; },

): this

Set global help option.

helpOption(

flags: string,

desc?: string,

opts?: ICommandOption<CO, CA, CG, PG, P>,

): this

Set help option.

helpOption(

flags: string,

desc?: string,

opts?: IAction<CO, CA, CG, PG, P>,

): 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, PG, P> & { 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, PG, P>

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, PG, P>

The action of the help option.

Returns

this