English

schema-dsl feature index

Use this page when you know the capability you need but not the document name. For a complete page-by-page map, see Document Map.

Define Schemas

Capability	Primary documents
Write compact DSL strings	DSL Syntax, Quick Start
Define object schemas	DSL Syntax, DSL Object Support
Mark fields required or optional	Optional Marker ?, Type Reference
Use enum values	Enum, DSL Syntax
Use multiple accepted types	Union Types, Union Type Guide, Multi-type Support
Use numeric ranges and comparison operators	Number Operators, DSL Syntax
Use builder chain methods	Chain Method List, TypeScript Guide
Use direct String chain helpers	String Extensions, TypeScript Guide

Validate Data

Capability	Primary documents
Validate synchronously	validate(), Validation Guide
Validate asynchronously	validateAsync(), Error Handling
Validate multiple records	Batch Validation, Validation Guide
Reuse a Validator instance	Validator, Performance Guide
Precompile schemas	compile(), Validator
Add conditional rules	Conditional API, Validation Guide
Format and customize errors	Error Handling, i18n User Guide

Runtime, TypeScript, and Side Effects

Capability	Primary documents
Understand TypeScript inference boundaries	TypeScript Guide, API Reference
Choose `schema-dsl/pure` vs `schema-dsl/runtime`	Runtime Isolation, Quick Start
Use side-effect-controlled entries	String Extensions, Runtime Isolation
Isolate runtime state by app, plugin, tenant, or worker	Runtime Isolation, Runtime Locale Support
Work with locale and messages at runtime	Runtime Locale Support, Dynamic Locale

Export and Interoperate

Capability	Primary documents
Understand JSON Schema output	JSON Schema Basics, API Reference
Export database schemas	Export Guide, Export Limitations
Export to MongoDB	MongoDB Exporter, Export Guide
Export to MySQL	MySQL Exporter, Export Guide
Export to PostgreSQL	PostgreSQL Exporter, Export Guide
Export schema documentation	Markdown Exporter, Export Guide
Convert schema types	TypeConverter, JSON Schema Basics

Reuse and Extend

Capability	Primary documents
Reuse schema fragments	SchemaUtils, SchemaUtils Chaining
Apply schema utility patterns	SchemaUtils Best Practices, SchemaUtils Advanced Issues
Analyze or transform schema objects	SchemaHelper, Validator Cache
Choose an extension path	Extension Overview, Framework Integration
Add custom DSL types	Custom DSL Types, Extension Overview
Use direct String-chain authoring	String Extensions, TypeScript Guide
Add custom keywords	Custom Validation Keywords
Package plugin lifecycle and hooks	Plugin Manager (Advanced)

Internationalize

Capability	Primary documents
Use built-in locale support	i18n Overview, Multi-language Support
Configure i18n in an application	i18n User Guide, Runtime Locale Support
Switch language dynamically	Dynamic Locale, Frontend i18n Guide
Add a custom locale	Add Custom Locale, i18n User Guide

Operate in Production

Capability	Primary documents
Choose production patterns	Best Practices, Project Structure Best Practices
Improve performance	Performance Guide, Validator Cache
Review security-sensitive usage	Security Notes, Export Limitations
Diagnose common failures	Troubleshooting, FAQ

API Reference

Need	Primary documents
Full public API details	API Reference
Compact API entry point	API Overview
Documentation by page	Document Map

Examples

Resource	Purpose
examples/docs	Runnable companion examples for documentation pages.
feature-index.ts	Representative example connecting DSL, String extensions, and exporters.
chain-methods.ts	Runnable coverage for field builder chain methods.
extensions-overview.ts	Runnable overview of extension paths.
custom-extensions.ts	Runnable custom DSL type example using pure DSL, `s('...')`, `s.xxx()` and runtime-scoped entries.
object-dsl-builder.ts	Object builder chaining, required-field control, and object schema conversion.
real-world.ts	Production-style composition for users, products, orders, queries, defaults, and async validation.