Command | /command/command.ts | cliffy@v1.0.0-rc.1

Module

x/cliffy/command/command.ts>Command#parse

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

method Command.prototype.parse

import { Command } from "https://deno.land/x/cliffy@v1.0.0-rc.1/command/command.ts";

parse(args?: string[]): Promise<TParentCommand extends Command<any> ? CommandResult<Record<string, unknown>, Array<unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, undefined> : CommandResult<MapTypes<TCommandOptions>, MapTypes<TCommandArguments>, MapTypes<TCommandGlobals>, MapTypes<TParentCommandGlobals>, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>>

Parse command line arguments and execute matched command.

Parameters

optional

args: string[] = [UNSUPPORTED]

Command line args to parse. Ex: cmd.parse( Deno.args )

Returns

Promise<TParentCommand extends Command<any> ? CommandResult<Record<string, unknown>, Array<unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, Record<string, unknown>, undefined> : CommandResult<MapTypes<TCommandOptions>, MapTypes<TCommandArguments>, MapTypes<TCommandGlobals>, MapTypes<TParentCommandGlobals>, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>>