@qkitt/queue 0.1.0

package/dist/worker/pipeline.d.ts

@@ -0,0 +1,22 @@
+import type { StepFn, WorkerFn } from './types';
+/**
+ * Compose steps into a pipeline (pipe / chain):
+ * output of step n is the input of step n+1.
+ *
+ * Common name: **pipeline** (also pipe, chain).
+ *
+ * @example
+ * const worker = pipeline(
+ *   async (id: string) => fetchUser(id),
+ *   async (user) => enrich(user),
+ *   async (enriched) => save(enriched),
+ * )
+ * withWorker(queue, worker)
+ */
+export declare function pipeline<A, B>(s1: StepFn<A, B>): WorkerFn<A, B>;
+export declare function pipeline<A, B, C>(s1: StepFn<A, B>, s2: StepFn<B, C>): WorkerFn<A, C>;
+export declare function pipeline<A, B, C, D>(s1: StepFn<A, B>, s2: StepFn<B, C>, s3: StepFn<C, D>): WorkerFn<A, D>;
+export declare function pipeline<A, B, C, D, E>(s1: StepFn<A, B>, s2: StepFn<B, C>, s3: StepFn<C, D>, s4: StepFn<D, E>): WorkerFn<A, E>;
+export declare function pipeline<A, B, C, D, E, F>(s1: StepFn<A, B>, s2: StepFn<B, C>, s3: StepFn<C, D>, s4: StepFn<D, E>, s5: StepFn<E, F>): WorkerFn<A, F>;
+export declare function pipeline<A, B, C, D, E, F, G>(s1: StepFn<A, B>, s2: StepFn<B, C>, s3: StepFn<C, D>, s4: StepFn<D, E>, s5: StepFn<E, F>, s6: StepFn<F, G>): WorkerFn<A, G>;
+//# sourceMappingURL=pipeline.d.ts.map

package/dist/worker/retry.d.ts

@@ -0,0 +1,31 @@
+import type { WorkerFn } from './types';
+export type RetryOptions = {
+    /**
+     * How many times to retry after the first failure.
+     * Total attempts = `retries + 1`.
+     */
+    retries: number;
+    /**
+     * Delay in ms before each retry. Number or function of
+     * (failedAttempt, error) where failedAttempt is 1-based.
+     */
+    delay?: number | ((failedAttempt: number, error: unknown) => number);
+    /** Return false to stop retrying early. Defaults to always retry. */
+    shouldRetry?: (error: unknown, failedAttempt: number) => boolean;
+};
+/** Thrown when all retry attempts are exhausted (or `shouldRetry` returns false). */
+export declare class RetryExhaustedError extends Error {
+    readonly name = "RetryExhaustedError";
+    readonly attempts: number;
+    readonly cause: unknown;
+    constructor(attempts: number, cause: unknown);
+}
+/**
+ * Wrap a worker so failed jobs are retried a fixed number of times.
+ *
+ * @example
+ * const worker = withRetry(async (job) => callApi(job), { retries: 3, delay: 100 })
+ * withWorker(queue, worker)
+ */
+export declare const withRetry: <T, R>(worker: WorkerFn<T, R>, options: RetryOptions | number) => WorkerFn<T, R>;
+//# sourceMappingURL=retry.d.ts.map

package/dist/worker/types.d.ts

@@ -0,0 +1,5 @@
+/** Sync or async unit of work over a single job/item. */
+export type WorkerFn<T, R = unknown> = (item: T) => R | Promise<R>;
+/** Alias used by pipelines — same shape as {@link WorkerFn}. */
+export type StepFn<TIn, TOut = unknown> = WorkerFn<TIn, TOut>;
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@qkitt/queue",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "A small, typed FIFO queue toolkit for TypeScript",
+  "license": "ISC",
+  "author": "eugene-p",
+  "keywords": [
+    "queue",
+    "fifo",
+    "worker",
+    "retry",
+    "pipeline",
+    "router",
+    "topic",
+    "persist",
+    "typescript",
+    "esm"
+  ],
+  "homepage": "https://github.com/eugene-p/qkitt-queue#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eugene-p/qkitt-queue.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eugene-p/qkitt-queue/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "build": "tsup && tsc -p tsconfig.build.json",
+    "pack:check": "npm pack --dry-run",
+    "release:check": "npm run typecheck && npm test && npm run build && npm run pack:check",
+    "prepublishOnly": "npm run release:check"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.10",
+    "tsup": "^8.5.1",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10"
+  }
+}