@quarkhz/query
v0.0.3
Published
Async data for Quark: query, mutation and bindQuery on the signal graph, with abort-aware runs and SSR hydration.
Maintainers
Readme
@quarkhz/query
Async data on the signal graph: query, mutation and bindQuery, with
abort-aware runs and SSR hydration.
npm i @quarkhz/query @quarkhz/react @quarkhz/coreimport { query } from '@quarkhz/query';
const user = query((id: number) => fetch(`/api/users/${id}`).then((r) => r.json()));
const snap = user.ensure(1); // a signal holding the snapshot; starts the fetch
snap.v.phase; // 'idle' | 'pending' | 'fulfilled' | 'rejected'
snap.v.data; // the payload once fulfilled
snap.v.error; // the reason once rejecteduser(1) reads the cached entry without starting anything; user.ensure(1)
starts it if needed. Both return a signal, so any computed, effect or sg.*
binding that reads the snapshot updates on its own — the component around it
never re-renders.
In JSX
Importing the package registers the sg.query, sg.mutation and sg.bindQuery
specials on sg:
import '@quarkhz/query'; // once, at the entry point
import { sg } from '@quarkhz/react';The registration is deliberately an import side effect. That is why this layer
lives in its own package: import { sg } alone no longer drags the async code
into the bundle, and a project that never fetches never pays for it.
Do not set
"sideEffects": falsein a project that re-bundles this package — the bundler would drop the registration and leavesg.queryundefined.
Notes
- Arguments are the cache key. When any argument is an object, array or function,
pass
options.keyexplicitly — the package refuses to guess. - A superseded run is aborted:
getCurrentAsyncAbortSignal()inside a fetcher gives theAbortSignalto hand tofetch. - On the server each request gets its own cache, and the client hydrates from it instead of re-fetching.
Links
- Documentation: https://quark-docs.vercel.app/
- Examples and issues: https://github.com/TheOnlyFastCoder2/quarkhz
- Signals runtime:
@quarkhz/core - React bindings:
@quarkhz/react
The source is closed; the published package contains the built dist only.
License
Apache-2.0
