TinyBase logoTinyBase β

useRelationshipIds

The useRelationshipIds hook returns a reactive object reflecting the Ids of the Relationships in a Relationships object, and registers a listener so that any changes will update .current.

useRelationshipIds(relationshipsOrRelationshipsId?: MaybeGetter<undefined | RelationshipsOrRelationshipsId>): {current: Ids}
TypeDescription
relationshipsOrRelationshipsId?MaybeGetter<undefined | RelationshipsOrRelationshipsId>

The Relationships object to use, or its Id.

returns{current: Ids}

A reactive object with a current Ids property.

Since

v8.1.0