TinyBase logoTinyBase β

useResultTable

The useResultTable hook returns a reactive object reflecting a result Table in a Queries object, and registers a listener so that any changes to that result will update .current.

useResultTable(
  queryId: MaybeGetter<string>,
  queriesOrQueriesId?: MaybeGetter<undefined | QueriesOrQueriesId>,
): {current: Table}
TypeDescription
queryIdMaybeGetter<string>

The Id of the Query (or a getter returning it).

queriesOrQueriesId?MaybeGetter<undefined | QueriesOrQueriesId>

The Queries object to use (plain or getter), or its Id.

returns{current: Table}

A reactive object with a current Table property.

Since

v8.1.0