Class Env<EnvValues>

A wrapper over "process.env" with types information.

const validate = Env.rules({
  PORT: Env.schema.number()
})

const validatedEnvVars = validate(process.env)

const env = new EnvValues(validatedEnvVars)
env.get('PORT') // type === number

Type Parameters

EnvValues extends Record<string, any>

Index

Constructors

constructor

new Env<EnvValues extends Record<string, any>>(
values: EnvValues,
): Env<EnvValues>
Creates a new Env instance
Type Parameters
- EnvValues extends Record<string, any>
Parameters
- values: EnvValues
  Validated environment values
Returns Env<EnvValues>
- Defined in src/env.ts:42

Properties

`Static`schema

schema: {} = envSchema

The schema builder for defining validation rules

Methods

`Static`create

create<Schema extends { [key: string]: ValidateFn<unknown> }>(
appRoot: URL,
schema: Schema,
): Promise<Env<{ [K in string | number | symbol]: ReturnType<Schema[K]> }>>
Create an instance of the env class by validating the environment variables. Also, the .env files are loaded from the appRoot
Type Parameters
- Schema extends { [key: string]: ValidateFn<unknown> }
Parameters
- appRoot: URL
  The application root directory URL
- schema: Schema
  Validation schema for environment variables
Returns Promise<Env<{ [K in string | number | symbol]: ReturnType<Schema[K]> }>>
Promise resolving to an Env instance with validated values
- Defined in src/env.ts:55

`Static`identifier

identifier(
name: string,
callback: (value: string) => string | Promise<string>,
): void
Define an identifier for any environment value. The callback is invoked when the value match the identifier to modify its interpolation.
Parameters
- name: string
  The identifier name
- callback: (value: string) => string | Promise<string>
  Callback function to process the identifier value
Returns void
Deprecated
use Env.defineIdentifier instead
- Defined in src/env.ts:76

`Static`defineIdentifier

defineIdentifier(
name: string,
callback: (value: string) => string | Promise<string>,
): void
Define an identifier for any environment value. The callback is invoked when the value match the identifier to modify its interpolation.
Parameters
- name: string
  The identifier name
- callback: (value: string) => string | Promise<string>
  Callback function to process the identifier value
Returns void
- Defined in src/env.ts:87

`Static`defineIdentifierIfMissing

defineIdentifierIfMissing(
name: string,
callback: (value: string) => string | Promise<string>,
): void
Define an identifier for any environment value, if it's not already defined. The callback is invoked when the value match the identifier to modify its interpolation.
Parameters
- name: string
  The identifier name
- callback: (value: string) => string | Promise<string>
  Callback function to process the identifier value
Returns void
- Defined in src/env.ts:102

`Static`removeIdentifier

removeIdentifier(name: string): void
Remove an identifier
Parameters
- name: string
  The identifier name to remove
Returns void
- Defined in src/env.ts:114

`Static`rules

rules<T extends { [key: string]: ValidateFn<unknown> }>(
schema: T,
): EnvValidator<T>
Define the validation rules for validating environment variables. The return value is an instance of the env validator
Type Parameters
- T extends { [key: string]: ValidateFn<unknown> }
Parameters
- schema: T
  Validation schema object
Returns EnvValidator<T>
EnvValidator instance
- Defined in src/env.ts:131

get

get<K extends string | number | symbol>(key: K): EnvValues[K]
Get the value of an environment variable by key. The values are looked up inside the validated environment and "process.env" is used as a fallback.

The second param is the default value, which is returned when the environment variable does not exist.
```
Env.get('PORT')

// With default value
Env.get('PORT', 3000)
```
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The environment variable key
Returns EnvValues[K]
The environment variable value or default
- Defined in src/env.ts:155
get<K extends string | number | symbol>(
key: K,
defaultValue: Exclude<EnvValues[K], undefined>,
): Exclude<EnvValues[K], undefined>
Get the value of an environment variable by key. The values are looked up inside the validated environment and "process.env" is used as a fallback.

The second param is the default value, which is returned when the environment variable does not exist.
```
Env.get('PORT')

// With default value
Env.get('PORT', 3000)
```
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The environment variable key
- defaultValue: Exclude<EnvValues[K], undefined>
  Default value if key is not found
Returns Exclude<EnvValues[K], undefined>
The environment variable value or default
- Defined in src/env.ts:156
get(key: string): undefined | string
Get the value of an environment variable by key. The values are looked up inside the validated environment and "process.env" is used as a fallback.

The second param is the default value, which is returned when the environment variable does not exist.
```
Env.get('PORT')

// With default value
Env.get('PORT', 3000)
```
Parameters
- key: string
  The environment variable key
Returns undefined | string
The environment variable value or default
- Defined in src/env.ts:160
get(key: string, defaultValue: string): string
Get the value of an environment variable by key. The values are looked up inside the validated environment and "process.env" is used as a fallback.

The second param is the default value, which is returned when the environment variable does not exist.
```
Env.get('PORT')

// With default value
Env.get('PORT', 3000)
```
Parameters
- key: string
  The environment variable key
- defaultValue: string
  Default value if key is not found
Returns string
The environment variable value or default
- Defined in src/env.ts:161

set

set<K extends string | number | symbol>(key: K, value: EnvValues[K]): void
Update/set value of an environment variable.

The value is not casted/validated using the validator, so make sure to set the correct data type.
```
Env.set('PORT', 3000)

Env.get('PORT') === 3000 // true
process.env.PORT === '3000' // true
```
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The environment variable key
- value: EnvValues[K]
  The value to set
Returns void
- Defined in src/env.ts:200
set(key: string, value: string): void
Update/set value of an environment variable.

The value is not casted/validated using the validator, so make sure to set the correct data type.
```
Env.set('PORT', 3000)

Env.get('PORT') === 3000 // true
process.env.PORT === '3000' // true
```
Parameters
- key: string
  The environment variable key
- value: string
  The value to set
Returns void
- Defined in src/env.ts:201

Class Env<EnvValues>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Env<EnvValues>

Properties

Staticschema

Methods

Staticcreate

Type Parameters

Parameters

Returns Promise<Env<{ [K in string | number | symbol]: ReturnType<Schema[K]> }>>

Staticidentifier

Parameters

Returns void

Deprecated

StaticdefineIdentifier

Parameters

Returns void

StaticdefineIdentifierIfMissing

Parameters

Returns void

StaticremoveIdentifier

Parameters

Returns void

Staticrules

Type Parameters

Parameters

Returns EnvValidator<T>

get

Type Parameters

Parameters

Returns EnvValues[K]

Type Parameters

Parameters

Returns Exclude<EnvValues[K], undefined>

Parameters

Returns undefined | string

Parameters

Returns string

set

Type Parameters

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Static`schema

`Static`create

`Static`identifier

`Static`defineIdentifier

`Static`defineIdentifierIfMissing

`Static`removeIdentifier

`Static`rules