Hyperlinkv0.8.0-beta.28

SchemaRepresentation

SchemaRepresentation.Referenceinterfaceeffect/SchemaRepresentation.ts:105
Reference

A named reference to a definition in the References map.

When to use

Use when a representation should point to a named definition instead of embedding the definition inline.

Details

$ref is the key into Document.references or MultiDocument.references. References are resolved lazily by toSchema and toCodeDocument.

Gotchas

Resolution throws at runtime if the key is not found in the references map.

export interface Reference {
  readonly _tag: "Reference"
  readonly $ref: string
}
Referenced by 2 symbols