Keywords

Only works with ArkType

This feature is only available with ArkEnv + ArkType and is not a part of arkenv/standard.

ArkEnv adds a small set of env-oriented keywords on top of ArkType's keyword set. You can reference them in any ArkEnv schema or type definition.

string

The following aliases can be referenced in any definition, e.g.:

import  from "arkenv";

// Hover to see the inferred type
const  = ({
  : "string.host",
});

import {  } from "arkenv";

const  = ("string.host");

// Hover to see the inferred type
type  = typeof .;

Prop

Type

An IP address (string.ip) or "localhost".

The following aliases can be referenced in any definition, e.g.:

import  from "arkenv";

// Hover to see the inferred type
const  = ({
  : "number.port",
});

import {  } from "arkenv";

const  = ("number.port");

// Hover to see the inferred type
type  = typeof .;

Prop

Type

An integer port in the range 0–65535.