taskflow-shams

library1.0.8jsnpmunverified

Taskflow Sham is a simple priority-based job queue implementation in TypeScript (v1.0.x). It requires SDK initialization with API keys before enqueuing jobs, and ships TypeScript types. Key differentiators include embedded validation via Supabase and a focus on minimal setup. The package is actively maintained with no recent updates.

devops

npm install taskflow-shams

package ↗

INSTALL

IMPORT

SIG · TASKFLOW-SHAMS

taskflow-shams

devopsjavascriptv1.0.8

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

QueueSDK

✓ import { QueueSDK } from 'taskflow-shams'

✗ const QueueSDK = require('taskflow-shams')

ESM-only; default export changed to named export in v1.0.0.

PriorityQueue

✓ import { PriorityQueue } from 'taskflow-shams'

For lower-level queue processing, but initialization of SDK is required first.

Job

✓ import { Job } from 'taskflow-shams'

✗ import { Job } from 'taskflow-shams/job'

TypeScript type for job objects.

Shows initialization with environment variables, SDK validation, and enqueuing a simple job.

import { QueueSDK } from 'taskflow-shams'; const apiKey = process.env.QUEUE_SDK_API_KEY ?? ''; const supabaseKey = process.env.SUPABASE_ANON_KEY ?? ''; const sdk = new QueueSDK(apiKey, supabaseKey); async function start() { await sdk.init(); sdk.enqueueJob(1, 2, 'Low priority job', 'lowPriority'); console.log('Job enqueued'); } start().catch(console.error);

Debug

Known issues

breakingSDK initialization (init()) is now required before enqueuing jobs.

fix

Call await sdk.init() before any enqueue calls.

affects: >=1.0.0

gotchaEnvironment variables QUEUE_SDK_API_KEY and SUPABASE_ANON_KEY must be set or passed explicitly.

fix

Ensure both keys are provided to the constructor or set in process.env.

affects: >=1.0.0

deprecatedThe legacy queue API (PriorityQueue class) may be deprecated in future versions.

fix

Use QueueSDK methods instead.

affects: <2.0.0

Errors

Common errors & fixes

Error: API key validation failed

Invalid or missing API key or Supabase anon key.

fix

Verify QUEUE_SDK_API_KEY and SUPABASE_ANON_KEY are correct and set.

TypeError: sdk.enqueue is not a function

Using sdk.enqueue before init() is called or using wrong instance.

fix

Ensure sdk.init() completes before calling enqueue/enqueueJob.

Upgrade

Version history

1.0.8latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Amazon

Resources

packagetaskflow-shams ↗