Env Core - API Reference

CreateEnvOptions

Option	Type	Description
`server?`	`TServer`	Server-only variables; validated only when `isServer` is true.
`client?`	`TClient`	Variables safe on the client; always validated unless `skipValidation`.
`clientPrefix?`	`TPrefix`	Prefix every `client` key must use (enforced at compile time and runtime).
`emptyStringAsUndefined?`	`boolean \| undefined`	Treat `""` as `undefined` before validation. Default `false`.
`isServer?`	`boolean \| undefined`	Override server detection. Default: no `window` on `globalThis`.
`onInvalidAccess?`	`OnInvalidAccessHandler`	Called when a non-client key is read on the client. May throw a custom error; otherwise the default is thrown.
`onValidationError?`	`OnValidationErrorHandler`	Called when schema validation fails. May throw a custom error; otherwise the default is thrown.
`runtimeEnv?`	`RuntimeEnvInput`	Loose record to read values from (e.g. `process.env`). Extra keys are allowed.
`runtimeEnvStrict?`	`object`	Explicit per-key mapping; mutually exclusive with `runtimeEnv`.

Option	Type	Description
`client`	`TClient`	Client-safe schema shape.
`clientPrefix`	`string \| undefined`	Prefix every `client` key must use (enforced at compile time and runtime).
`emptyStringAsUndefined`	`boolean`	Treat `""` as `undefined` before validation. Default: `false`.
`isServer`	`boolean`	Whether we're in a server context. Default: `typeof window === "undefined"`.
`onInvalidAccess`	`OnInvalidAccessHandler \| undefined`	Called when a non-client key is read on the client. May throw a custom error; otherwise the default is thrown. Default: `undefined`.
`onValidationError`	`OnValidationErrorHandler \| undefined`	Called when schema validation fails. May throw a custom error; otherwise the default is thrown. Default: `undefined`.
`runtime`	`RuntimeEnvInput`	Record to read values from (e.g. `process.env`).
`server`	`TServer`	Server-only schema shape.
`skipValidation`	`boolean`	Skip schema validation and return picked runtime values only. Default: `false`.