JavaScript APIs

Cloudflare Queues is integrated with Cloudflare Workers. To send and receive messages, you must use a Worker.

A Worker that can send messages to a Queue is a producer Worker, while a Worker that can receive messages from a Queue is a consumer Worker. It is possible for the same Worker to be a producer and consumer, if desired.

In the future, we expect to support other APIs, such as HTTP endpoints to send or receive messages. To report bugs or request features, go to the Cloudflare Community Forums ↗. To give feedback, go to the #queues ↗ Discord channel.

Producer

These APIs allow a producer Worker to send messages to a Queue.

An example of writing a single message to a Queue:

type Environment = {
  readonly MY_QUEUE: Queue;
};

export default {
  async fetch(req: Request, env: Environment): Promise<Response> {
    await env.MY_QUEUE.send({
      url: req.url,
      method: req.method,
      headers: Object.fromEntries(req.headers),
    });
    return new Response('Sent!');
  },
};

The Queues API also supports writing multiple messages at once:

const sendResultsToQueue = async (results: Array<any>, env: Environment) => {
  const batch: MessageSendRequest[] = results.map((value) => ({
    body: JSON.stringify(value),
  }));
  await env.queue.sendBatch(batch);
};

`Queue`

A binding that allows a producer to send messages to a Queue.

interface Queue<Body = unknown> {
  send(body: Body, options?: QueueSendOptions): Promise<void>;
  sendBatch(messages: Iterable<MessageSendRequest<Body>>, options?: QueueSendBatchOptions): Promise<void>;
}

send(bodyunknown, options?{ contentType?: QueuesContentType }): Promise<void>
- Sends a message to the Queue. The body can be any type supported by the structured clone algorithm ↗, as long as its size is less than 128 KB.
- When the promise resolves, the message is confirmed to be written to disk.
sendBatch(bodyIterable<MessageSendRequest<unknown>>): Promise<void>
- Sends a batch of messages to the Queue. Each item in the provided Iterable ↗ must be supported by the structured clone algorithm ↗. A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
- When the promise resolves, the messages are confirmed to be written to disk.

`MessageSendRequest`

A wrapper type used for sending message batches.

type MessageSendRequest<Body = unknown> = {
  body: Body;
  options?: QueueSendOptions;
};

body unknown
- The body of the message.
- The body can be any type supported by the structured clone algorithm ↗, as long as its size is less than 128 KB.
optionsQueueSendOptions
- Options to apply to the current message, including content type and message delay settings.

`QueueSendOptions`

Optional configuration that applies when sending a message to a queue.

contentTypeQueuesContentType
- The explicit content type of a message so it can be previewed correctly with the List messages from the dashboard feature. Optional argument.
- As of now, this option is for internal use. In the future, contentType will be used by alternative consumer types to explicitly mark messages as serialized so they can be consumed in the desired type.
- See QueuesContentType for possible values.
delaySecondsnumber
- The number of seconds to delay a message for within the queue, before it can be delivered to a consumer.
- Must be an integer between 0 and 43200 (12 hours). Setting this value to zero will explicitly prevent the message from being delayed, even if there is a global (default) delay at the queue level.

`QueueSendBatchOptions`

Optional configuration that applies when sending a batch of messages to a queue.

delaySecondsnumber
- The number of seconds to delay messages for within the queue, before it can be delivered to a consumer.
- Must be a positive integer.

`QueuesContentType`

A union type containing valid message content types.

// Default: json
type QueuesContentType = "text" | "bytes" | "json" | "v8";

Use "json" to send a JavaScript object that can be JSON-serialized. This content type can be previewed from the Cloudflare dashboard ↗. The json content type is the default.
Use "text" to send a String. This content type can be previewed with the List messages from the dashboard feature.
Use "bytes" to send an ArrayBuffer. This content type cannot be previewed from the Cloudflare dashboard ↗ and will display as Base64-encoded.
Use "v8" to send a JavaScript object that cannot be JSON-serialized but is supported by structured clone ↗ (for example Date and Map). This content type cannot be previewed from the Cloudflare dashboard ↗ and will display as Base64-encoded.

If you specify an invalid content type, or if your specified content type does not match the message content's type, the send operation will fail with an error.

Consumer

These APIs allow a consumer Worker to consume messages from a Queue.

To define a consumer Worker, add a queue() function to the default export of the Worker. This will allow it to receive messages from the Queue.

By default, all messages in the batch will be acknowledged as soon as all of the following conditions are met:

The queue() function has returned.
If the queue() function returned a promise, the promise has resolved.
Any promises passed to waitUntil() have resolved.

If the queue() function throws, or the promise returned by it or any of the promises passed to waitUntil() were rejected, then the entire batch will be considered a failure and will be retried according to the consumer's retry settings.

export default {
  async queue(
    batch: MessageBatch,
    env: Environment,
    ctx: ExecutionContext
  ): Promise<void> {
    for (const message of batch.messages) {
      console.log('Received', message);
    }
  },
};

The env and ctx fields are as documented in the Workers documentation.

Or alternatively, a queue consumer can be written using the (deprecated) service worker syntax:

addEventListener('queue', (event) => {
  event.waitUntil(handleMessages(event));
});

In service worker syntax, event provides the same fields and methods as MessageBatch, as defined below, in addition to waitUntil() ↗.

`MessageBatch`

A batch of messages that are sent to a consumer Worker.

interface MessageBatch<Body = unknown> {
  readonly queue: string;
  readonly messages: Message<Body>[];
  ackAll(): void;
  retryAll(options?: QueueRetryOptions): void;
}

queue string
- The name of the Queue that belongs to this batch.
messages Message[]
- An array of messages in the batch. Ordering of messages is best effort -- not guaranteed to be exactly the same as the order in which they were published. If you are interested in guaranteed FIFO ordering, please email the Queues team.
ackAll() void
- Marks every message as successfully delivered, regardless of whether your queue() consumer handler returns successfully or not.
retryAll(options?: QueueRetryOptions) void
- Marks every message to be retried in the next batch.
- Supports an optional options object.

`Message`

A message that is sent to a consumer Worker.

interface Message<Body = unknown> {
  readonly id: string;
  readonly timestamp: Date;
  readonly body: Body;
  readonly attempts: number;
  ack(): void;
  retry(options?: QueueRetryOptions): void;
}

id string
- A unique, system-generated ID for the message.
timestamp Date
- A timestamp when the message was sent.
body unknown
- The body of the message.
- The body can be any type supported by the structured clone algorithm ↗, as long as its size is less than 128 KB.
attempts number
- The number of times the consumer has attempted to process this message. Starts at 1.
ack() void
- Marks a message as successfully delivered, regardless of whether your queue() consumer handler returns successfully or not.
retry(options?: QueueRetryOptions) void
- Marks a message to be retried in the next batch.
- Supports an optional options object.

`QueueRetryOptions`

Optional configuration when marking a message or a batch of messages for retry.

declare interface QueueRetryOptions {
  delaySeconds?: number;
}

delaySecondsnumber
- The number of seconds to delay a message for within the queue, before it can be delivered to a consumer.
- Must be a positive integer.

Was this helpful?

Cloudflare Dashboard Discord Community Learning Center Support Portal

Cookie Settings