Skip to main content

JsonSchemaRef Interface

Type entry containing a reference to a definition in the schema.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface JsonSchemaRef

Properties

Property Alerts Type Description
$ref Alpha JsonRefPath Reference to a definition in the schema.

Property Details

$ref

Reference to a definition in the schema.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature
$ref: JsonRefPath;

Type: JsonRefPath

See Also

https://json-schema.org/draft/2020-12/json-schema-core#name-direct-references-with-ref.

See Also

https://json-schema.org/draft/2020-12/json-schema-core#name-schema-references.