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

x/cliffy/flags/mod.ts

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
Extremely Popular
Go to Latest
import * as cliffy from "https://deno.land/x/cliffy@v1.0.0-rc.2/flags/mod.ts";

Classes

A validation error is thrown when the command is wrongly used by the user. For example: If the user passes some invalid options or arguments to the command.

Enums

E
OptionType
deprecated

Variables

Boolean type handler. Excepts true, false, 1, 0

Integer type handler. Excepts any integer value.

Number type handler. Excepts any numeric value.

String type handler. Excepts any value.

Functions

Parse command line arguments.

Interfaces

Options for a flag argument.

Argument parsing informations.

Flag options.

Parse result. The parse context will be returned by the parseFlags method and can be also passed as first argument to the parseFlags method.

Parser options.

Type Aliases

Available build-in argument types.

Default flag value or a callback method that returns the default value.

Default value callback function to lazy load the default value.

T
IDefaultValue
deprecated
T
IFlagArgument
deprecated
T
IFlagOptions
deprecated
T
IFlagsResult
deprecated
T
IParseOptions
deprecated
T
ITypeHandler
deprecated
T
ITypeInfo
deprecated

Parse method for custom types. Gets the raw user input passed as argument and returns the parsed value.

A callback method for custom processing or mapping of flag values.