Azure SDK for JavaScript – Queue Storage

Overview

The Azure Queue Storage client library for JavaScript enables you to interact with Azure Queue Storage from Node.js or browsers. You can create queues, push and retrieve messages, and manage queue properties.

Install the SDK

Run the following command to add the package to your project:

npm install @azure/storage-queue

Create a Queue

Below is a self‑contained example. Click Run to see the output in the console.

import { QueueServiceClient } from "@azure/storage-queue";

async function main() {
  const connectionString = "";
  const queueName = "sample-queue";

  const queueServiceClient = QueueServiceClient.fromConnectionString(connectionString);
  const queueClient = queueServiceClient.getQueueClient(queueName);
  await queueClient.create();
  console.log(`Queue "${queueName}" created`);
}

main().catch(console.error);

Push a Message

import { QueueServiceClient } from "@azure/storage-queue";

async function main() {
  const connectionString = "";
  const queueName = "sample-queue";
  const message = "Hello, Azure Queue!";

  const queueClient = QueueServiceClient.fromConnectionString(connectionString).getQueueClient(queueName);
  const enqueueResult = await queueClient.sendMessage(message);
  console.log("Message enqueued, ID:", enqueueResult.messageId);
}

main().catch(console.error);

Peek Messages

import { QueueServiceClient } from "@azure/storage-queue";

async function main() {
  const connectionString = "";
  const queueName = "sample-queue";

  const queueClient = QueueServiceClient.fromConnectionString(connectionString).getQueueClient(queueName);
  const peeked = await queueClient.peekMessages({ numberOfMessages: 5 });
  for (const message of peeked.peekedMessageItems) {
    console.log(`Peeked message: ${message.messageText}`);
  }
}

main().catch(console.error);

Pop (Dequeue) a Message

import { QueueServiceClient } from "@azure/storage-queue";

async function main() {
  const connectionString = "";
  const queueName = "sample-queue";

  const queueClient = QueueServiceClient.fromConnectionString(connectionString).getQueueClient(queueName);
  const received = await queueClient.receiveMessages({ numberOfMessages: 1, visibilityTimeout: 30 });
  for (const msg of received.receivedMessageItems) {
    console.log(`Dequeued: ${msg.messageText}`);
    await queueClient.deleteMessage(msg.messageId, msg.popReceipt);
    console.log("Message deleted");
  }
}

main().catch(console.error);

Delete a Queue

import { QueueServiceClient } from "@azure/storage-queue";

async function main() {
  const connectionString = "";
  const queueName = "sample-queue";

  const queueClient = QueueServiceClient.fromConnectionString(connectionString).getQueueClient(queueName);
  await queueClient.delete();
  console.log(`Queue "${queueName}" deleted`);
}

main().catch(console.error);

API Reference

Explore the full API documentation on the Microsoft Docs site.