Queue SDK

A message queue for asynchronous task processing, enabling reliable communication between distributed components.

Import

import { $ } from 'sdk.do'

Operations

create

Create a new message queue.

const result = await $.Queue.create({
  // parameters
})

delete

Permanently remove the queue.

const result = await $.Queue.delete({
  // parameters
})

send

Send a message to the queue.

const result = await $.Queue.send({
  // parameters
})

receive

Retrieve messages from the queue for processing.

const result = await $.Queue.receive({
  // parameters
})

acknowledge

Confirm successful processing of a message.

const result = await $.Queue.acknowledge({
  // parameters
})

retry

Return a message to the queue for reprocessing.

const result = await $.Queue.retry({
  // parameters
})

purge

Remove all messages from the queue.

const result = await $.Queue.purge({
  // parameters
})

inspect

View messages without removing them from the queue.

const result = await $.Queue.inspect({
  // parameters
})

Events

created

Triggered when a new queue is created.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.created(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.created({ /* data */ })

deleted

Triggered when queue is removed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.deleted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.deleted({ /* data */ })

Message.sent

Triggered when a message is added to the queue.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.Message.sent(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.Message.sent({ /* data */ })

Message.received

Triggered when a message is retrieved for processing.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.Message.received(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.Message.received({ /* data */ })

Message.acknowledged

Triggered when message processing is confirmed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.Message.acknowledged(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.Message.acknowledged({ /* data */ })

Message.retried

Triggered when a message is returned for reprocessing.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.Message.retried(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.Message.retried({ /* data */ })

purged

Triggered when all messages are removed from queue.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Queue.purged(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Queue.purged({ /* data */ })

Queue SDK

On this page