@overture-stack/lectern-dictionary

Lectern Dictionary

Note

This may not be the module you are looking to import.

This is a sub-module used as a dependency by both the Lectern Client and Lectern Server.

If you are building an application that will interact with a Lectern Server over HTTP, or wants to validate data using a Lectern Dictionary, you likely want to import the Lectern Client.

This package defines the structure of Lectern Dictionaries, including providing the TypeScript type definitions to use the dictionary in code and the schemas to validate that a given JSON object is a valid Lectern Dictionary.

The Lectern Dictionary meta-schema is formally defined in TypeScript and exported as the type Dictionary. This definition is created using Zod schemas, which are also exported from this package and available for use to confirm a given object is a valid Lectern Dictionary.

A JSON Schema definition of the Lectern Dictionary structure is also available if you are looking for a non-TypeScript mechanism for validating Lectern Dictionaries.