Command | /command/command.ts | cliffy@v0.24.2

Module

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

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)

ValidationErrorOptions

CompleteHandlerResult

dim

red

CompleteHandlerResult

method Command.prototype.globalEnv

import { Command } from "https://deno.land/x/cliffy@v0.24.2/command/command.ts";

globalEnv<N extends string, G extends TypedEnv<N, P, CO, Merge<CPT, Merge<CGT, CT>>, R>, MG extends MapValue<G, V>, R extends IEnvVarOptions["required"] = undefined, P extends IEnvVarOptions["prefix"] = undefined, V = undefined>(

name: N,

description: string,

options?: Omit<IGlobalEnvVarOptions, "value"> & { required?: R; prefix?: P; value?: IEnvVarValueHandler<MapTypes<ValueOf<G>>, V>; },

): Command<CPG, CPT, CO, CA, Merge<CG, MG>, CT, CGT, CP>

Type Parameters

N extends string

G extends TypedEnv<N, P, CO, Merge<CPT, Merge<CGT, CT>>, R>

MG extends MapValue<G, V>

optional

R extends IEnvVarOptions["required"] = undefined

optional

P extends IEnvVarOptions["prefix"] = undefined

optional

V = undefined

Parameters

name: N

description: string

optional

options: Omit<IGlobalEnvVarOptions, "value"> & { required?: R; prefix?: P; value?: IEnvVarValueHandler<MapTypes<ValueOf<G>>, V>; }

Returns

Command<CPG, CPT, CO, CA, Merge<CG, MG>, CT, CGT, CP>