BaseOverlaySchema

The schema every overlay schema extends.

An overlay schema narrows properties to the fields the overlay carries.

@example

export class MyOverlaySchema extends BaseOverlaySchema {
  override properties = Schema<{ subnetName: string }>();
}

@group

Overlays

Index

Constructors

• constructor

Properties

• anchors
• overlayId
• properties

Constructors

constructor

• BaseOverlaySchema(): BaseOverlaySchema

• Returns BaseOverlaySchema

Properties

anchors

anchors: BaseAnchorSchema[] = ...

The anchors this overlay was built from, i.e. the models it joins.

overlayId

overlayId: string = ...

The ID of the overlay, unique across the infrastructure.

properties

properties: {} = ...

The properties of the overlay.

---

Type declaration

• [key string]: unknown