Class EnvValidator<Schema>

Exposes the API to validate environment variables against a pre-defined schema.

The class is not exported in the main API and used internally.

Type Parameters

Schema extends { [key: string]: ValidateFn<unknown> }

Index

Constructors

Methods

Constructors

constructor

new EnvValidator<Schema extends { [key: string]: ValidateFn<unknown> }>(
schema: Schema,
): EnvValidator<Schema>
Creates a new EnvValidator instance
Type Parameters
- Schema extends { [key: string]: ValidateFn<unknown> }
Parameters
- schema: Schema
  The validation schema object
Returns EnvValidator<Schema>
- Defined in src/validator.ts:37

Methods

validate

validate(
values: { [K: string]: undefined | string },
): { [K in string | number | symbol]: ReturnType<Schema[K]> }
Accepts an object of values to validate against the pre-defined schema.

The return value is a merged copy of the original object and the values mutated by the schema validator.
Parameters
- values: { [K: string]: undefined | string }
  Object of environment variable values to validate
Returns { [K in string | number | symbol]: ReturnType<Schema[K]> }
Validated and transformed environment variables
- Defined in src/validator.ts:52