TinyBase logoTinyBase β

useRelationshipsStoreTableIds

The useRelationshipsStoreTableIds hook returns the Store, local table Id, and remote table Id for a given Relationships object and relationship Id.

useRelationshipsStoreTableIds(
  relationshipsOrId: MaybeGetter<undefined | RelationshipsOrRelationshipsId>,
  relationshipId: MaybeGetter<string>,
): {
  store: Store | undefined;
  localTableId: Id | undefined;
  remoteTableId: Id | undefined;
}
TypeDescription
relationshipsOrIdMaybeGetter<undefined | RelationshipsOrRelationshipsId>

The Relationships object, its Id, or a getter returning either.

relationshipIdMaybeGetter<string>

The Id of the relationship, or a getter returning it.

returns{ store: Store | undefined; localTableId: Id | undefined; remoteTableId: Id | undefined; }

An object with store, localTableId, and remoteTableId getter properties.

Since

v8.1.0