env

arkenv() returns a typed object of validated (and coerced) values. Import that object as env and read properties from it in application code.

import arkenv from "@arkenv/core";

export const env = arkenv({
  DATABASE_URL: "string",
  PORT: "number.port = 3000",
});

env.DATABASE_URL; // string
env.PORT; // number

Default source

Without a config object, ArkEnv reads process.env. Override with options.env when the host injects variables another way.

Your framework or process manager must populate the source before arkenv() runs. See Loading .env files.

Return shape

Default arkenv() returns a validated object and throws ArkEnvError on failure. For a result object, import arkenv from @arkenv/core/safe or @arkenv/standard/safe.

Core and @arkenv/standard return a plain object. Next.js and Nuxt wrap that object in a Proxy.

Framework proxies

Next.js and Nuxt Proxies throw if client code reads a server-only key, or if code reads a key missing from the schema.

Vite and Bun plugins rewrite the client graph so only public keys are inlined. The app still imports env from your schema module.

See Client vs. server and Error reporting.

Typing helpers

Export Infer when you need the schema's output type without reading typeof env.

import arkenv, { type Infer } from "@arkenv/core";

const schema = { API_URL: "string" } as const;
export const env = arkenv(schema);
export type Env = Infer<typeof schema>;

Next steps