Class default<T>

Represents an environment variable with methods to resolve its value based on the environment type.

Type Parameters

T
The type of the environment variable value.

Index

Constructors

Methods

resolve syncResolve

Constructors

constructor

new default<T>(
    paramName: string,
    type: EnvironmentType,
    optional?: boolean,
    paramPrefix?: string,
): default<T>
Constructs a new instance of the EnvironmentVar class.
Type Parameters
- T
Parameters
- paramName: string
  The name of the environment variable.
- type: EnvironmentType
  The type of the environment.
- Optionaloptional: boolean
  Indicates whether the environment variable is optional.
- OptionalparamPrefix: string = ...
  The prefix to be added to the environment variable name.
Returns default<T>
- Defined in src/Config/EnvironmentVar.ts:59

Methods

resolve

resolve(): Promise<undefined | T>
Resolves the value based on the environment type.

Returns Promise<undefined | T>
- The resolved value.
- Defined in src/Config/EnvironmentVar.ts:89

syncResolve

syncResolve(): T
Resolves the value of the environment variable synchronously.

Returns T
- The resolved value of the environment variable.
Throws
- If the environment type is not 'Local'.
- Defined in src/Config/EnvironmentVar.ts:76