bunqueue-client 0.1.1 → 0.1.2

package/README.md

@@ -24,6 +24,50 @@ npm install bunqueue-client
 # or: bun add bunqueue-client / pnpm add bunqueue-client / deno add npm:bunqueue-client
 ```
 
+## Quick start
+
+Sixty seconds from zero to a working queue. Step 1, start the server (requires [Bun](https://bun.sh), or use the Docker image):
+
+```bash
+bunx bunqueue start
+```
+
+Step 2, create `app.ts`: add a job and process it, in the same file for the sake of the demo:
+
+```typescript
+import { Queue, Worker } from 'bunqueue-client';
+
+const worker = new Worker('hello', async (job) => {
+  console.log('processing', job.data);
+  return { greeted: job.data.name };
+});
+worker.on('completed', (job, result) => {
+  console.log('completed', job.id, result);
+  worker.close();
+});
+
+const queue = new Queue('hello');
+await queue.add('greet', { name: 'world' });
+queue.close();
+```
+
+Step 3, run it with the runtime you already use:
+
+```bash
+node --experimental-strip-types app.ts    # Node 22 or later
+bun app.ts                                # Bun
+deno run -A app.ts                        # Deno 2 or later
+```
+
+Expected output:
+
+```
+processing { name: 'world' }
+completed 019f40a5-... { greeted: 'world' }
+```
+
+That is the whole model: the server owns state, retries, and scheduling, your code only adds and processes. In production the producer and the worker are separate services, often in different languages: the [Python client](https://github.com/egeominotti/bunqueue/tree/main/sdk/python) speaks the same protocol against the same queue. Defaults are `host: 'localhost'`, `port: 6789`, so constructors need no options on a local setup.
+
 ## Producing jobs
 
 ```typescript
@@ -132,6 +176,8 @@ Authentication uses server side tokens (`AUTH_TOKENS`). Transport security uses
 
 The following features require the in process Bun runtime and are intentionally out of scope for this client: embedded mode, sandboxed workers, and `QueueEvents`. Use webhooks or the HTTP SSE and WebSocket endpoints for event streaming.
 
+Note on numeric payloads: JavaScript numbers are IEEE 754 doubles, exact up to 2^53. Pass larger 64 bit identifiers, for example snowflake IDs, as strings to avoid silent precision loss. Never place `BigInt` values in job data.
+
 ## Quality assurance
 
 Every release is validated against a real bunqueue server, spawned fresh for each run, across every supported runtime:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunqueue-client",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Cross-runtime TypeScript client for the bunqueue job queue server — Node.js, Bun, Deno and Cloudflare Workers",
   "license": "MIT",
   "type": "module",
@@ -29,7 +29,7 @@
     "lint": "biome lint src tests",
     "format": "biome format --write src tests",
     "check": "biome check src tests",
-    "test:workers": "cd tests/workers && node run.mjs"
+    "test:workers": "bun pm pack --destination tests/workers && cd tests/workers && mv bunqueue-client-*.tgz bunqueue-client.tgz && bun install && node run.mjs"
   },
   "keywords": [
     "queue",