schema.bundleschema.md

October 26, 2023 ยท View on GitHub

Home > @datashaper/schema > BundleSchema

BundleSchema interface

A schema for defining custom bundle types.

Signature:

export interface BundleSchema 

Properties

PropertyModifiersTypeDescription
$schemastring
acceptsRelationshipConstraint[]The kinds of relationships that may be defined in bundle sources.
profile?string(Optional) Defines the resource type. Known resource types should have accompanying processors and rendering components. Unknown resource types can be interrogated to determine if the format is understandable by an existing component. Note that this could be inferred from $schema, but a simple string here is easier to deal with in code.