Command | /deps/cliffy.ts | lume@v1.17.2

Module

x/lume/deps/cliffy.ts>Command#env

🔥 Static site generator for Deno 🦕

lumeland/lume

Very Popular

assertNotStrictEquals

Row

CheckboxOptionSettings

CursorPositionOptions

DenoLandProviderOptions

GenericInputPromptOptions

GenericInputPromptSettings

GenericListKeys

GenericListOption

GenericListOptions

GenericListOptionSettings

GenericListSettings

GenericPromptKeys

GenericPromptOptions

GenericPromptSettings

GithubProviderOptions

NestLandProviderOptions

UpgradeCommandOptions

UpgradeOptions

ValidationErrorOptions

CheckboxValueSettings

CompleteHandlerResult

GenericListValueOptions

GenericListValueSettings

Tty

bel

tty

dim

red

DigestAlgorithmObject

Key

ElementCreationOptions

denoDomDisableQuerySelectorCodeGeneration

nodesFromString

NodeType

esbuild.ts

AnalyzeMetafileOptions

FormatMessagesOptions

SubdirectoryMoveError

DrawableFontPointSize

DrawableGravity

DrawableRectangle

DrawableRoundRectangle

MagickImageCollection

IMagickImageCollection

initializeImageMagick

PixelInterpolateMethod

FormatInputPathObject

sep

SEP

CFB

SSF

method Command.prototype.env

Re-export

import { Command } from "https://deno.land/x/lume@v1.17.2/deps/cliffy.ts";

env<N extends string, G extends TypedEnv<N, P, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, R>, MG extends MapValue<G, V>, R extends EnvVarOptions["required"] = undefined, P extends EnvVarOptions["prefix"] = undefined, V = undefined>(

description: string,

options: Omit<EnvVarOptions, "value"> & { global: true; required?: R; prefix?: P; value?: EnvVarValueHandler<MapTypes<ValueOf<G>>, V>; },

): Command<TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, Merge<TCommandGlobals, MG>, TCommandTypes, TCommandGlobalTypes, TParentCommand>

Add new environment variable.

env<TNameAndValue extends string, TEnvVar extends TypedEnv<TNameAndValue, TPrefix, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, TRequired>, TMappedEnvVar extends MapValue<TEnvVar, TMappedValue>, TRequired extends EnvVarOptions["required"] = undefined, TPrefix extends EnvVarOptions["prefix"] = undefined, TMappedValue = undefined>(

description: string,

options?: Omit<EnvVarOptions, "value"> & { required?: TRequired; prefix?: TPrefix; value?: EnvVarValueHandler<MapTypes<ValueOf<TEnvVar>>, TMappedValue>; },

): Command<TParentCommandGlobals, TParentCommandTypes, Merge<TCommandOptions, TMappedEnvVar>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand>

Add new environment variable.

Type Parameters

N extends string

G extends TypedEnv<N, P, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, R>

MG extends MapValue<G, V>

optional

R extends EnvVarOptions["required"] = undefined

optional

P extends EnvVarOptions["prefix"] = undefined

optional

V = undefined

Parameters

Name of the environment variable.

description: string

The description of the environment variable.

options: Omit<EnvVarOptions, "value"> & { global: true; required?: R; prefix?: P; value?: EnvVarValueHandler<MapTypes<ValueOf<G>>, V>; }

Environment variable options.

Returns

Command<TParentCommandGlobals, TParentCommandTypes, TCommandOptions, TCommandArguments, Merge<TCommandGlobals, MG>, TCommandTypes, TCommandGlobalTypes, TParentCommand>

Type Parameters

TNameAndValue extends string

TEnvVar extends TypedEnv<TNameAndValue, TPrefix, TCommandOptions, Merge<TParentCommandTypes, Merge<TCommandGlobalTypes, TCommandTypes>>, TRequired>

TMappedEnvVar extends MapValue<TEnvVar, TMappedValue>

optional

TRequired extends EnvVarOptions["required"] = undefined

optional

TPrefix extends EnvVarOptions["prefix"] = undefined

optional

TMappedValue = undefined

Parameters

description: string

optional

options: Omit<EnvVarOptions, "value"> & { required?: TRequired; prefix?: TPrefix; value?: EnvVarValueHandler<MapTypes<ValueOf<TEnvVar>>, TMappedValue>; }

Returns

Command<TParentCommandGlobals, TParentCommandTypes, Merge<TCommandOptions, TMappedEnvVar>, TCommandArguments, TCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommand>