How-To

Use this section when you want task-oriented guidance instead of API-level detail.

Pages in this section:

• Basic Checks for day-to-day validation recipes
• Composite Checks for allOf(...), anyOf(...), oneOf(...), and not(...)
• Reading Results for result(options?) and output shaping
• Data Updates for patch-style update validation, immutability, and update factory flows
• Decorated Classes for decorator-based class validation
• Object Factory for validated construction and hydration
• Coded Message Catalog for stable codes, i18n catalogs, and translated output workflows
• SchemaCheck for validating input against the supported JSON Schema subset

If you are new to the package, a good reading order is:

1. Start with Basic Checks for the most common validation recipes.
2. Continue with Composite Checks when you need allOf(...), anyOf(...), oneOf(...), or not(...).
3. Read Data Updates when validation depends on both incoming patch data and existing values.
4. Finish with Reading Results when you need to shape output for application code.

Optionally you may also:

1. Read Decorated Classes when you want validation rules to live next to DTO-like class definitions. Keeping validity logic in the class definition can often be a clean design.
2. Use Object Factory when validation and object construction or update should happen together. This applies to data classes that know how to validate input and use it.
3. Read Coded Message Catalog when you need stable result codes with localized messages. In addition, you can separate messages from your code and organize them into catalogs.
4. Use SchemaCheck when you want to validate data from a supported JSON Schema document instead of writing fluent rules directly.
5. Read Platform Compatibility when your code must run in both browser and Node or uses binary and schema-file features.