Hyperlinkv0.8.0-beta.28

← SchemaRepresentation

SchemaRepresentation.fromJsonSchemaDocumentfunctioneffect/SchemaRepresentation.ts:2995
(
  document: JsonSchema.Document<"draft-2020-12">,
  options?: {
    readonly onEnter?:
      | ((js: JsonSchema.JsonSchema) => JsonSchema.JsonSchema)
      | undefined
  }
): Document

Parses a Draft 2020-12 JSON Schema document into a Document.

When to use

Use when you need to import a Draft 2020-12 JSON Schema document into the Effect schema representation system.

Details

options.onEnter is an optional hook called on each JSON Schema node before processing, allowing pre-transformation.

Gotchas

JSON Schema import is best-effort. Some JSON Schema constructs do not map exactly to Effect schema representations, and importing a schema previously emitted by toJsonSchemaDocument may produce an equivalent approximation rather than the original representation shape.

This throws if a $ref cannot be resolved within the document's definitions. Circular $refs are detected and cause an error.

constructorsDocumenttoJsonSchemaDocumentfromJsonSchemaMultiDocument
Source effect/SchemaRepresentation.ts:299513 lines
export function fromJsonSchemaDocument(document: JsonSchema.Document<"draft-2020-12">, options?: {
  readonly onEnter?: ((js: JsonSchema.JsonSchema) => JsonSchema.JsonSchema) | undefined
}): Document {
  const { references, representations: schemas } = fromJsonSchemaMultiDocument({
    dialect: document.dialect,
    schemas: [document.schema],
    definitions: document.definitions
  }, options)
  return {
    representation: schemas[0],
    references
  }
}