zod-envkit

---

EnvMetaEntry = object

Defined in: generate.ts:14

Metadata entry for a single environment variable.

This file is part of the stable public API: it powers the CLI generators, and is intended to be reusable by consumers.

Stable in 1.2.

Since

1.0.0

Properties

default?

optional default: string

Defined in: generate.ts:46

Default value (documentation only).

Since

1.1.0

---

deprecated?

optional deprecated: boolean | string

Defined in: generate.ts:54

Mark variable as deprecated in docs. Use true for a generic warning (⚠️) or a string to show an explanation (e.g. "Use FOO instead").

Since

1.1.0

---

description?

optional description: string

Defined in: generate.ts:18

Human-readable description.

---

example?

optional example: string

Defined in: generate.ts:25

Example value used for .env.example and documentation.

Tip: do NOT put real secrets here.

---

group?

optional group: string

Defined in: generate.ts:39

Optional group/section for docs (primarily for Markdown format).

Since

1.1.0

---

link?

optional link: string

Defined in: generate.ts:68

Optional link to further documentation.

Since

1.1.0

---

required?

optional required: boolean

Defined in: generate.ts:32

Whether the variable is required.

Default Value

true

---

since?

optional since: string

Defined in: generate.ts:61

Version when the variable was introduced (documentation only).

Since

1.1.0