TinyBase logoTinyBase β

RelationshipCallback

The RelationshipCallback type describes a function that takes a Relationship's Id and a callback to loop over each local Row within it.

(
  relationshipId: Id,
  forEachRow: (rowCallback: RowCallback) => void,
): void
TypeDescription
relationshipIdId

The Id of the Relationship that the callback can operate on.

forEachRow(rowCallback: RowCallback) => void

A function that will let you iterate over the local Row objects in this Relationship.

returnsvoid

This has no return value.

A RelationshipCallback is provided when using the forEachRelationship method, so that you can do something based on every Relationship in the Relationships object. See that method for specific examples.

Since

v1.0.0