Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Structure

Defines an interface for a serializable structure. Usually created from a normal JavaScript object.

Hierarchy

  • Structure

Index

Properties

Properties

Optional channel

channel: number | string

The ID of the channel that serialized this structure. If omitted, then the root channel sent this message. Used to multiplex messages.

Optional refs

refs: {}

A map of reference IDs to objects. Objects can additionally reference other objects.

Type declaration

  • [key: string]: Ref

root

root: any

The entry point into the structure. Can be a reference to an object in the refs property.

Generated using TypeDoc