@tanstack-query-with-orbitjs/core
v0.2.0
Published
A library for using TanStack Query with Orbit.js.
Downloads
3
Maintainers
Readme
@tanstack-query-with-orbitjs/core
A library for using TanStack Query with Orbit.js.
This is the UI framework agnostic core, which could be seen as corresponding to @tanstack/query-core
in original TanStack Query.
Usage
Install using your preferred Node.js package manager. For example:
pnpm add @tanstack-query-with-orbitjs/core
@tanstack-query-with-orbitjs/core
comes with three new classes that enable the integration between TanStack Query and Orbit.js:
LiveQueryClient
Replacement forQueryClient
. (ExtendsQueryClient
class.)LiveQueryObserver
Replacement forQueryObserver
. (ExtendsQueryObserver
class.)LiveInfiniteQueryObserver
Replacement forInfiniteQueryObserver
. (ExtendsInfiniteQueryObserver
class.)
It also exports the following types:
LiveQueryClientConfig
Interface describing the config passed to theLiveQueryClient
constructor. (ExtendsQueryClientConfig
interface.)QueryMeta
Module augmented, and declaration merged more specific version of theQueryMeta
interface.GetQueryOrExpressions
Type which describes the first parameter of theMemorySource#query
method.