Command | /command/mod.ts | cliffy@v0.18.2

method Command.prototype.option

Re-export

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

option<G extends Record<string, unknown> | void = CG>(

flags: string,

desc: string,

opts: ICommandOption<Partial<CO>, CA, Merge<CG, G>, PG, P> & { global: true; } | IFlagValueHandler,

): Command<CO, CA, Merge<CG, G>, PG, P>

Add a new option.

option<O extends Record<string, unknown> | void = CO>(

flags: string,

desc: string,

opts?: ICommandOption<Merge<CO, O>, CA, CG, PG, P> | IFlagValueHandler,

): Command<Merge<CO, O>, CA, CG, PG, P>

Add a new option.

Type Parameters

optional

G extends Record<string, unknown> | void = CG

flags: string

Flags string like: -h, --help, --manual requiredArg:string [optionalArg: number] [...restArgs:string]

desc: string

Flag description.

opts: ICommandOption<Partial<CO>, CA, Merge<CG, G>, PG, P> & { global: true; } | IFlagValueHandler

Flag options or custom handler for processing flag value.

Command<CO, CA, Merge<CG, G>, PG, P>

optional

O extends Record<string, unknown> | void = CO

flags: string

desc: string

optional

opts: ICommandOption<Merge<CO, O>, CA, CG, PG, P> | IFlagValueHandler

Command<Merge<CO, O>, CA, CG, PG, P>