API reference
Overview
Find the right guide or jump to signatures generated from enumwaii's public JSDoc.
The reference pages linked below are generated at build time from JSDoc attached to the published TypeScript exports. The source comments are the authority: changes to an export and its documentation are reviewed and released together.
Choose by task
| Goal | Main API | Detailed guide |
|---|---|---|
| Declare an enumwaii | em, Enumwaii | API essentials |
| Use owned members | .enum, .values | Member surfaces |
| Validate external input | .parse, .safeParse, .is | Runtime boundaries |
| Compose declarations | .pick, .omit, .extend, em.combine | Branding and identity |
| Build exhaustive lookups | .derive, .deriveTo | Derivation |
| Integrate schemas | Standard Schema, Zod, Valibot | Schemas and adapters |
Entry points
enumwaii— package map for the core entry point, schema adapters, and optional derivation helpers.- Core package — declarations, parsing, composition, errors, and public utility types on one searchable page.
- Zod adapter and Valibot adapter — optional adapter entry points.
- Derivation helpers — optional reusable transformations.
The reference follows the package entry points. Use the page table of contents or search to jump to an individual symbol. Start with Getting started for the recommended member surface and validation flow.