Install SureQ
Requirements
- Node.js 22 or newer.
- No other runtime dependencies.
Install the package
npm install @sureq/coreESM and CommonJS
The docs use ES modules (import). CommonJS works too:
const { Queue, MemoryStore } = require('@sureq/core')TypeScript
SureQ ships its own type definitions, so there is nothing extra to install.
Use a module setting that reads the package exports map, such as:
{
"compilerOptions": {
"module": "NodeNext",
"moduleResolution": "NodeNext",
"strict": true
}
}moduleResolution can also be "Bundler" if you use a bundler.
Producer-only code imports from the @sureq/core/producer entry, which needs one of these settings. See Producer-only pods.
Where jobs are stored
A Queue with no store option creates its own in-memory store. That is all you need to try SureQ, write tests, or run jobs inside one process.
To share one store between several queues in the same process, create a MemoryStore and pass it in:
import { MemoryStore, Queue } from '@sureq/core'
const store = new MemoryStore()
const emails = new Queue('emails', { store })
const reports = new Queue('reports', { store })A queue closes only a store it created. A store you pass in stays open after queue.close(), so close it yourself with await store.close() when you are done.
The in-memory store is not durable. Jobs are lost when the process exits, and other processes cannot see them. When the first worker starts on it, SureQ logs one warning. For a queue named emails, the default logger prints:
store is not durable; jobs are lost on restart { queue: 'emails' }You need a durable store when:
- jobs must survive a restart or a deploy, or
- several processes or pods share one queue.
A durable store is a store adapter that implements the store contract. A Producer always needs a store option, because it never creates one. The store contract is experimental until 1.1. See Stores.