/command-types.ts | args@2.1.0

Module

x/args/command-types.ts

Extensible CLI arguments parser for Deno with intelligent TypeScript inference

KSXGitHub/deno-args

Go to Latest

index.ts (default module)

CollectOptionDescriptor

Command

CommandHelp

DrainOptionDescriptor

DrainOptionFilterReturn

Err

PartialOptionDescriptor

CollectOptionDescriptor

DrainOptionDescriptor

DrainOptionFilterReturn

PartialOptionDescriptor

Err

err

import * as args from "https://deno.land/x/args@2.1.0/command-types.ts";

Namespaces

CommandReturn

Variables

v BLANK	Starting point of a command parser construction chain
v Describe	Assign description to a command parser during construction chain
v FlaggedCommand	Add a flag parser on top of existing command parser
v MergeCommand	Merge two command parsers
v ParseFailure	Create a failure for `Command::extract`
v SubCommand	Declare add subcommand to existing command parser

Interfaces

I Command	Interface of a command parser
I CommandHelp	Interface of component of help message of command parser
I CommandReturn.Failure	Interface of parsing failure
I CommandReturn.Main	Interface of a main command variant
I CommandReturn.Sub	Interface of a sub command variant

Type Aliases

T CommandReturn	Success variant of `Command::extract`
T FlaggedCommandReturn	Type of value of FlaggedCommand
T MergeCommandReturn	Type of value of MergeCommand
T ParseFailure	Failure variant of `Command::extract`
T SubCommandReturn	Type of value of SubCommand