Class Environment

Hierarchy

Environment

Index

Constructors

Properties

cwd tag vars FALSE initial

Accessors

Methods

getFlag getNumber getString

Constructors

constructor

new Environment(cwd?: string, vars?: ProcessEnv, tag?: undefined | string): Environment
Parameters
- cwd: string = ''
  
  Current working directory.
- vars: ProcessEnv = {}
  
  Environment variables
- tag: undefined | string = ...
  
  Tag to identify the environment (e.g. timestamp)
Returns Environment
- Defined in ensuite/toolbox/conf/conf.ts:29

Properties

`Readonly` cwd

cwd: string = ''

Current working directory.

`Readonly` tag

tag: undefined | string = ...

Tag to identify the environment (e.g. timestamp)

`Readonly` vars

vars: ProcessEnv = {}

Environment variables

`Static` FALSE

FALSE: string[] = ...

Which string values are counted as falsy by getFlag

`Static` initial

initial: Environment = ...

Snapshot of the earliest known process environment (at the moment this module is evaluated)

Accessors

[toStringTag]

get [toStringTag](): undefined | string
Returns undefined | string
- Defined in ensuite/toolbox/conf/conf.ts:40

Methods

getFlag

getFlag<T, U>(name: string, fallback?: (() => T | U)): T | U
Type Parameters
- T extends boolean
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
- Defined in ensuite/toolbox/conf/conf.ts:42

getNumber

getNumber<T, U>(name: string, fallback?: (() => T | U)): T | U
Type Parameters
- T extends number
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
- Defined in ensuite/toolbox/conf/conf.ts:57

getString

getString<T, U>(name: string, fallback?: (() => T | U)): T | U
Type Parameters
- T extends string
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
- Defined in ensuite/toolbox/conf/conf.ts:51

Generated using TypeDoc