Interface IParent

Interface implemented by something that can be a parent of a Collab.

Only reference this interface directly if you are a Collab implementing it in order to be a Parent. Otherwise, use the Parent type.

See CObject's implementation for "default" behavior.

Hierarchy

IParent
- IRuntime

Implemented by

Index

Methods

Methods

childSend

childSend(child: Collab<CollabEventsRecord>, messageStack: (string | Uint8Array)[], metaRequests: MetaRequest[]): void

- Defined in core/build/esm/src/core/parent.d.ts:28
Internal (Collab.send) use only.

Sends the given message on behalf of child. In general, this parent is then responsible for delivering the given message to Collab.receive on each replica of child, with guarantees set by the runtime.

Parameters
- child: Collab<CollabEventsRecord>
  
  The caller.
- messageStack: (string | Uint8Array)[]
  
  As in Collab.send.
- metaRequests: MetaRequest[]
  
  As in Collab.send.
Returns void

fromID

fromID<C>(id: CollabID<C>, startIndex?: number): undefined | C

- Defined in core/build/esm/src/core/parent.d.ts:53
Inverse of idOf.

Specifically, given a CollabID returned by idOf on some replica of this parent, returns this replica's copy of the original descendant. If that descendant does not exist (e.g., it was deleted or it is not present in this program version), returns undefined.

Type Parameters
- C extends Collab<CollabEventsRecord, C>
Parameters
- id: CollabID<C>
  
  A CollabID from idOf.
- Optional startIndex: number
  
  Internal (parent) use only. If provided, treat id.collabIDPath as if it starts at startIndex instead of 0.
Returns undefined | C

idOf

idOf<C>(descendant: C): CollabID<C>

- Defined in core/build/esm/src/core/parent.d.ts:39
Returns a CollabID for the given strict descendant of this parent.

The CollabID may be passed to fromID on any replica of this parent (but not other parents) to obtain that replica's copy of descendant.

Type Parameters
- C extends Collab<CollabEventsRecord, C>
Parameters
- descendant: C
  
  A strict (non-this) descendant of this parent.
Returns CollabID<C>

Generated using TypeDoc