@arkenv/core

@arkenv/core is the ArkType validation engine. It exports arkenv() and a type() that includes ArkType's keywords and ArkEnv's. arktype is a required peer. There are no runtime dependencies.

Writing Zod or Valibot?

Use @arkenv/standard instead. That keeps arktype out of the tree.

Installation

Install the engine and its peer. The peer is required.

npm install @arkenv/core arktype

Usage

./env.ts

import  from "@arkenv/core";

export const  = ({
  HOST: "string.host = 'localhost'",
  PORT: "number.port = 3000",
  DATABASE_URL: "string",
});

Exports

The main entry is the throw-path runtime. Issue helpers and the non-throwing parser live on subpaths so the default import stays small.

Export	Kind	Role
`arkenv`	function (default + named)	Validate and return a typed env object
`type`	function	ArkType `type` with `keywords`
`ArkEnvError`	class	Thrown on validation failure
`ArkEnvConfig`	type	Options object
`EnvSchema`	type	Declarative schema map
`Infer`	type	Infer output from a schema
`SafeArkEnvResult`	type	Result shape returned by `@arkenv/core/safe`

Subpaths

Issue formatting and the non-throwing parser are separate entries.

Import	Role
`@arkenv/core`	Throw-path `arkenv()` and `type()`
`@arkenv/core/issues`	`formatIssues`, `getSchemaKeys`, and `EnvIssue` / `EnvIssueCode` / `EnvIssueMeta`
`@arkenv/core/safe`	`arkenv` — result object instead of a throw (default + named export)

./env.ts

import  from "@arkenv/core/safe";

const  = (
  { PORT: "number.port" },
  { : { PORT: "invalid" } },
);

if (!.) {
  console.error(.);
}

Next steps

options

Configuration options passed to the arkenv() runtime.

keywords

Built-in keyword extensions like string.host and number.port.

schema

Schema definition shapes accepted by arkenv().

@arkenv/standard

ArkType-free runtime adapter for Standard Schema validators.