glide-mq
Classes
| Class | Description |
|---|---|
| BatchError | - |
| Broadcast | Broadcast - Fan-out message publisher for pub/sub patterns. |
| BroadcastWorker | - |
| ConnectionError | - |
| CycleError | - |
| DelayedError | - |
| FlowProducer | - |
| GlideMQError | - |
| Job | - |
| Producer | - |
| Queue | - |
| QueueEvents | - |
| ServerlessPool | - |
| UnrecoverableError | - |
| WaitingChildrenError | - |
| Worker | - |
Interfaces
| Interface | Description |
|---|---|
| AddAndWaitOptions | - |
| BatchOptions | - |
| BroadcastOptions | - |
| BroadcastWorkerOptions | - |
| ConnectionOptions | - |
| DAGFlow | A complete DAG flow definition for submission via FlowProducer.addDAG(). |
| DAGNode | A node in a DAG flow. Each node is a job with optional dependencies on other nodes. The deps array lists the names of nodes that must complete before this node can run. |
| DeadLetterQueueOptions | - |
| FlowJob | - |
| FlowProducerOptions | - |
| GetJobsOptions | - |
| IamCredentials | IAM authentication credentials for AWS ElastiCache/MemoryDB. |
| JobCounts | - |
| JobData | - |
| JobNode | - |
| JobOptions | - |
| JobTemplate | - |
| Metrics | - |
| MetricsDataPoint | - |
| MetricsOptions | - |
| PasswordCredentials | Standard password-based credentials. |
| ProducerOptions | - |
| QueueEventsOptions | - |
| QueueOptions | - |
| RateLimitConfig | - |
| SandboxOptions | - |
| ScheduleOpts | - |
| SchedulerEntry | - |
| SearchJobsOptions | - |
| Serializer | Custom serializer for job data and return values. |
| TokenBucketConfig | - |
| WorkerInfo | - |
| WorkerOptions | - |
| WorkflowJobDef | - |
Type Aliases
| Type Alias | Description |
|---|---|
| BatchProcessor | - |
| GracefulShutdownHandle | - |
| Processor | - |
| ReadFrom | Represents the client's read from strategy. |
Variables
| Variable | Description |
|---|---|
| JSON_SERIALIZER | Default JSON serializer used when no custom serializer is provided. |
| serverlessPool | Module-level singleton for convenient use in serverless handlers. |
Functions
| Function | Description |
|---|---|
| chain | Chain: execute jobs sequentially. Each step becomes a child of the next, so step N+1 only runs after step N completes. The last job in the array runs first; the first job in the array runs last and is the top-level parent. |
| chord | Chord: run a group of jobs in parallel, then execute a callback job with the results. The callback is the parent, the group members are children. |
| compileSubjectMatcher | Compile an array of subject patterns into a single matcher function. Returns a function that returns true if the subject matches any pattern. Returns null if patterns is empty or undefined (no filtering). |
| dag | DAG: submit a directed acyclic graph of jobs where each job can depend on multiple other jobs. The graph is validated for cycles and submitted in topological order (leaves first). |
| gracefulShutdown | Register SIGTERM and SIGINT handlers that gracefully close all provided components. Returns a Promise that resolves when all components have been closed. |
| group | Group: execute jobs in parallel. All jobs run concurrently. A synthetic parent job (name: 'group') waits for all children. When complete, the parent's processor receives all children's results via getChildrenValues(). |
| isClusterClient | Detect whether a client is a GlideClusterClient. Uses instanceof with a duck-type fallback for cases where the client comes from a different copy/version of @glidemq/speedkey (dependency duplication). |
| isTracingEnabled | True when a real OTel API is available (either user-provided or auto-detected). |
| matchSubject | Match a dot-separated subject against a pattern. - * matches exactly one segment - > matches one or more trailing segments (must be the last token) - Literal tokens match exactly |
| setTracer | Allow the user to supply their own tracer instance. If not called, the tracer is auto-resolved from @opentelemetry/api. |
| topoSort | Topological sort of DAG nodes using Kahn's algorithm. Returns nodes in submission order (leaves first, roots last). Throws CycleError if a cycle is detected. |
| validateDAG | Validate that a set of DAG nodes forms a valid DAG (no cycles). Throws CycleError if a cycle is detected. Throws Error if a node references a non-existent dependency. |