EnvName - API reference

API reference › @evolu/common › Config › EnvName

type EnvName = string &
  import("./Brand.ts").Brand<"ConstantCaseIdentifier"> &
  import("./Brand.ts").Brand<"MaxLength255">;

Defined in: packages/common/src/Config.ts:76

An environment variable name in Evolu's configuration convention.

Names are ConstantCaseIdentifiers of at most 255 characters, including the application prefix. This is an Evolu convention, not an operating-system limit. Double underscores do not introduce nesting.

Example

import { assertErr, assertOk, EnvName } from "@evolu/common";

assertOk(EnvName.fromUnknown("APP_MAX_OWNER_BYTES"), "APP_MAX_OWNER_BYTES");
assertErr(EnvName.fromUnknown("APP_maxOwnerBytes"));
assertErr(EnvName.fromUnknown("APP_DB__PORT"));