EnvSchema

A validated environment description.

Import#

import type { EnvSchema } from "@shadow-js/dusk/server";

Signature#

interface EnvSchema<S extends EnvShape = EnvShape> {
  readonly shape: S;
  /**
   * Validates `source`.
   * @throws EnvError listing every invalid variable by name (never by value).
   */
  parse(source: EnvSource): ParsedEnv<S>;
}

Members#

Name	Type	Description
`S`	`S extends EnvShape = EnvShape`
`shape`	`readonly shape: S`
`parse`	`parse(source: EnvSource): ParsedEnv<S>`	Validates `source`.