@peoplesgrocers/instantdb-qwik (1.0.63-rc.1)

Published 2026-09-12 15:15:24 +00:00 by GrocerPublishAgent

Setup this registry in your project .npmrc file:

@peoplesgrocers:registry=

To install the package using npm, run the following command:

npm install @peoplesgrocers/instantdb-qwik@1.0.63-rc.1

or add it to the package.json file:

"@peoplesgrocers/instantdb-qwik": "1.0.63-rc.1"

For more information on the npm registry, see the documentation.

@peoplesgrocers/instantdb-qwik

Qwik bindings for InstantDB -- a realtime database you can use from the browser.

This is a fork of @instantdb/react adapted for Qwik's signal-based reactivity. It connects to a self-hosted InstantDB server.

Install

npm install @peoplesgrocers/instantdb-qwik@rc

Install the rc tag, not latest. See Versioning below.

Versioning

The version of this package is the @instantdb/core version it is built and validated against, plus an -rc.N suffix. The suffix increments until the pairing is known to work. 1.0.11-rc.2 means "binding for InstantDB 1.0.11, second candidate". The binding has no version line of its own, so you can pin @instantdb/core exactly and know which binding matches.

To publish, tag qwik-v<core-version>-rc.<n>. The workflow rewrites the workspace:* dependencies to that core version.

CAUTION: Do not run npm publish from the workspace by hand. pnpm pack stamps @instantdb/core: 0.0.0, and the published package cannot resolve. This is what broke 1.0.5, which still holds the latest tag.

Quick start

import { createInstantQwik, i, id } from '@peoplesgrocers/instantdb-qwik';

const schema = i.schema({
  entities: {
    todos: i.entity({ text: i.string(), done: i.boolean() }),
  },
});

const db = createInstantQwik({
  schema,
  appId: 'YOUR_APP_ID',
  apiURI: 'https://your-instant-server.example.com',
  websocketURI: 'wss://your-instant-server.example.com',
});

Hooks

All hooks take the db signal as their first argument:

import {
  useQuery,
  useAuth,
  useConnectionStatus,
} from '@peoplesgrocers/instantdb-qwik';

// Query data reactively
const state = useQuery(db, { todos: {} });

// Auth state
const auth = useAuth(db);

// Connection status
const status = useConnectionStatus(db);

Transacting

db.value?.transact(
  db.value.tx.todos[id()].update({ text: 'Buy milk', done: false }),
);

API

This package re-exports everything from @instantdb/core (schema helpers, types, id, tx, lookup, i) plus the Qwik-specific hooks:

createInstantQwik -- create a database instance
useQuery -- subscribe to a query
useAuth -- subscribe to auth state
useUser -- get the current user
useConnectionStatus -- subscribe to connection status
useLocalId -- get a stable local identifier

License

AGPL-3.0

Dependencies

ID	Version
@instantdb/version	1.0.63
@peoplesgrocers/instantdb-core	1.0.63-rc.1

Development dependencies

ID	Version
@arethetypeswrong/cli	^0.18.5
@builder.io/qwik	^1.19.2
npm-run-all	^4.1.5
tshy	^3.0.2
typescript	^5.9.3
vite	^5.2.0

Peer dependencies

ID	Version
@builder.io/qwik	>=1.5.0

Details

npm

2026-09-12 15:15:24 +00:00

AGPL-3.0

172 KiB

Assets (1)

instantdb-qwik-1.0.63-rc.1.tgz 172 KiB

Versions (1) View all

1.0.63-rc.1

2026-09-12