BaseAnchorSchema

The schema every anchor schema extends.

An anchor schema narrows properties to the fields the anchor exposes. That shape is the contract other modules match against, so treat a change to it as a breaking change.

@example

export class MyAnchorSchema extends BaseAnchorSchema {
  override properties = Schema<{ awsRegionId: string }>();
}

@group

Overlays

Index

Constructors

• constructor

Properties

• anchorId
• parent
• properties

Constructors

constructor

• BaseAnchorSchema(): BaseAnchorSchema

• Returns BaseAnchorSchema

Properties

anchorId

anchorId: string = ...

The ID of the anchor, unique within its parent.

parent

parent: IModelReference & { type: NodeType } = ...

The model that declared the anchor.

properties

properties: {} = ...

The properties the anchor exposes, and that consumers filter on.

---

Type declaration

• [key string]: unknown