/command/types.ts | cliffy@v1.0.0-rc.3

Module

x/cliffy/command/types.ts

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)

Type

ActionListType

BashCompletionsCommand

FishCompletionsCommand

ZshCompletionsCommand

DenoLandProviderOptions

EnvVar

EnvVarOptions

Example

GithubProviderOptions

GithubVersions

GlobalEnvVarOptions

GlobalOptionOptions

NestLandProviderOptions

UpgradeCommandOptions

UpgradeOptions

ValidationErrorOptions

CompleteHandlerResult

dim

red

CompleteHandlerResult

import * as cliffy from "https://deno.land/x/cliffy@v1.0.0-rc.3/command/types.ts";

Interfaces

I Argument	Argument details.
I ArgumentValue	Argument parsing informations.
I CommandResult	Result of `cmd.parse()` method.
I CompleteOptions	Completion options.
I Completion	Completion settings.
I EnvVar	Environment variable settings.
I EnvVarOptions	Environment variable options
I Example	Example settings.
I GlobalEnvVarOptions	Environment variable options
I GlobalOptionOptions	Command option options.
I Option	Command option settings.
I OptionOptions
I TypeDef	Type settings.
I TypeOptions	Type options.

Type Aliases

T ActionHandler	Action handler for commands and options.
T CommandOptions
T CompleteHandler	Type parser method.
T CompleteHandlerResult
T DefaultValue	Default flag value or a callback method that returns the default value.
T Description	Description handler.
T DescriptionHandler	Description handler.
T EnvVarValueHandler
T ErrorHandler
T HelpHandler	Help callback method to print the help. Invoked by the `--help` option and `help` command and the `.getHelp()` and `.showHelp()` methods.
T Id
T OptionValueHandler
T TypeHandler	Parse method for custom types. Gets the raw user input passed as argument and returns the parsed value.
T TypeOrTypeHandler
T ValuesHandlerResult
T VersionHandler	Version callback method to print the version. Invoked by the `--help` option command and the `.getVersion()` and `.showHelp()` methods.