Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/opinecli/deps.ts>Command#option

Opine's application generator
Latest
method Command.prototype.option
Re-export
import { Command } from "https://deno.land/x/opinecli@2.0.0/deps.ts";

Add a new option.

Type Parameters

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

Parameters

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, MapOptionTypes<G>>, PG, P> & { global: true; } | IFlagValueHandler

Flag options or custom handler for processing flag value.

Returns

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

Type Parameters

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

Parameters

flags: string
desc: string
optional
opts: ICommandOption<Merge<CO, MapOptionTypes<O>>, CA, CG, PG, P> | IFlagValueHandler

Returns

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