Class Schema

constructor

• new Schema(
      root: RefType,
      env?: ReadonlyMap<string, Record> | Readonly<Record<string, Record>>,
  ): Schema

  Parameters

  • root: RefType
  • Optionalenv: ReadonlyMap<string, Record> | Readonly<Record<string, Record>>

  Returns Schema

Readonlyenv

Readonlyroot

accepts

• accepts(d: Doc): boolean

  true iff validate(d).ok.

  Parameters

  • d: Doc

  Returns boolean

compatibleWith

• compatibleWith(other: Schema): boolean

  True if every document this schema accepts is also accepted by other. Delegates to ops/subschema.ts.

  Parameters

  • other: Schema

  Returns boolean

equivalent

• equivalent(other: Schema): boolean

  True if both schemas accept exactly the same documents. Delegates to ops/subschema.ts.

  Parameters

  • other: Schema

  Returns boolean

extract

• extract(...labels: string[]): Schema

  The minimal subschema recognizing only documents built from labels. Delegates to ops/extract.ts.

  Parameters

  • ...labels: string[]

  Returns Schema

isEmpty

• isEmpty(): boolean

  True iff this schema's root record is unsatisfiable. Delegates to ops/prune.ts.

  Returns boolean

normalize

• normalize(): Schema

  The canonical minimal schema equivalent to this one. Delegates to ops/minimize.ts.

  Returns Schema

prune

• prune(): Schema

  An equivalent schema with everything that can never match removed. Delegates to ops/prune.ts.

  Returns Schema

resolve

• resolve(type: FieldType): Record | ScalarType | AnyFieldType

  An AnyFieldType or ScalarType resolves to itself; a RefType is a single environment lookup -- env values are always Records (enforced by checkRefs), so ref chains cannot occur.

  Parameters

  • type: FieldType

  Returns Record | ScalarType | AnyFieldType

validate

• validate(d: Doc): ValidationResult

  Full conformance per model.md §7: cardinality, closedness, and target type matching. Collects every problem found, not just the first.

  Parameters

  • d: Doc

  Returns ValidationResult