Schema

The Schema Guide is sequenced by default for "practical use": basic information that will let you be productive quickly. You'll have a solid grasp of what's possible just reading the first few guides and poking at the examples.

• You'll be making frequent use of the provided base schemas.
• You need to know how to define structure using child properties.
• The value processor pipelines attached to handlers are the ticket to schema customization.
• Schema options tune data traversal, and metadata decorates schemas for external tooling.
• Dive into advanced topics like unions and selectors.

If you prefer to understand things from first principles,

• Read about the architecture and the abstract "mental model"
• Debate the rationale of Yet Another Schema.
• Understand the nuances of the schema choreographs recursive traversal through input data
• Be amused by the schema compilation process.

Also check out key working examples in the repo:

• basics.js - start here
• unions.js - nuances of union discrimination
• conditionals.js - petting zoo of various conditionals like $if vs $gate vs $when
• opaque.js and implicit.js - inhibiting deep inspection of output data after transformation
• reference-lookup.js - when data within the output has correlated rules
• recursive-dynamic.js - demonstrates both dynamic input data and recursive schemas
• metadata.js - leveraging metadata from within and without the schema