Skip to content

zod-envkit


loadEnv<T>(schema, opts?): LoadEnvFail | LoadEnvOk<T>

Defined in: index.ts:71

Validate process.env using a Zod schema.

  • On success: returns { ok: true, env } (typed).
  • On failure:
    • returns { ok: false, error } by default
    • throws ZodError if opts.throwOnError === true

Type Parameters

T

T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

schema

T

opts?

LoadEnvOptions

Returns

LoadEnvFail | LoadEnvOk<T>

Example

ts
const result = loadEnv(EnvSchema);
if (!result.ok) {
  console.error("Invalid environment:\n" + formatZodError(result.error));
  process.exit(1);
}
export const env = result.env;

Since

1.0.0

Released under the MIT License.