Registry / storage / azure-queue-node

azure-queue-node

JSON →
library1.1.0jsnpmunverified

A simplified Azure Queue Storage client library for Node.js (v1.1.0) that supports creating, deleting, listing queues; putting, updating, getting, deleting messages; and retrieving approximate message counts. Lightweight alternative to the official Azure SDK with simple API but limited to Queue Storage operations only. Released 2017, no recent updates. Primarily uses callbacks, no promise support. Supports JSON or base64 message encoding. Requires configuration via environment variable or explicit client setup.

npm install azure-queue-node
INSTALL
IMPORT
SIG · AZURE-QUEUE-NODE
A
azure-queue-node
storagejavascriptv1.1.0
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.

defaultClient
const client = require('azure-queue-node').getDefaultClient();
import { getDefaultClient } from 'azure-queue-node';
Package uses CommonJS; no ESM exports.
createClient
const client = require('azure-queue-node').createClient({...});
const createClient = require('azure-queue-node').createClient;
Correct: call as function. Wrong: import as reference without calling.
setDefaultClient
require('azure-queue-node').setDefaultClient({...});
const setDefaultClient = require('azure-queue-node').setDefaultClient;
setDefaultClient modifies global default client; no return value.
Client
const { Client } = require('azure-queue-node');
const Client = require('azure-queue-node').Client;
Client is a named export, but not typically instantiated directly.

Demonstrates setting up the client, creating a queue, putting, retrieving, and deleting a message.

const azureQueue = require('azure-queue-node'); // Set default client configuration (or use env var CLOUD_STORAGE_ACCOUNT) azureQueue.setDefaultClient({ accountUrl: 'https://myaccount.queue.core.windows.net/', accountName: 'myaccount', accountKey: process.env.AZURE_STORAGE_KEY ?? '' }); const client = azureQueue.getDefaultClient(); // Create a queue client.createQueue('mytasks', true, (err) => { if (err) return console.error(err); console.log('Queue created'); // Put a message client.putMessage('mytasks', { task: 'example' }, (err) => { if (err) return console.error(err); console.log('Message added'); // Get messages client.getMessages('mytasks', { maxMessages: 10 }, (err, messages) => { if (err) return console.error(err); console.log('Retrieved messages:', messages); // Delete a message if (messages && messages.length > 0) { client.deleteMessage('mytasks', messages[0].messageId, messages[0].popReceipt, (err) => { if (err) return console.error(err); console.log('Message deleted'); }); } }); }); });
Debug
Known issues
breakingThe package uses callbacks only; promises and async/await are not supported directly.
fix
Wrap calls in a promise manually, e.g., require('util').promisify()
affects: <=1.1.0
gotchaEnvironment variable 'CLOUD_STORAGE_ACCOUNT' parsing is fragile: AccountKey must be last, quotes not supported.
fix
Use setDefaultClient() instead of environment variable.
affects: <=1.1.0
gotchaDefault client getter is named 'getDefaultClient', but example mistakenly uses 'azurTable.getDefaultClient()' - wrong module name.
fix
Use azureQueue.getDefaultClient() correctly.
affects: <=1.1.0
deprecatedThe 'request' library used for HTTP is deprecated; security vulnerabilities expected.
fix
Consider using a maintained HTTP client or switch to official Azure SDK.
affects: >=0.0.0
Errors
Common errors & fixes
Cannot find module 'azure-queue-node'
Package not installed or not in node_modules.
fix
Run: npm install azure-queue-node
TypeError: azureQueue.getDefaultClient is not a function
Misnamed import or missing require.
fix
Ensure: const azureQueue = require('azure-queue-node');
no element in sequence
Parsing error when environment variable CLOUD_STORAGE_ACCOUNT is malformed (e.g., AccountKey not last, missing semicolons).
fix
Set connection info via setDefaultClient() instead of using environment variable.
Upgrade
Version history
1.1.0latest on npm
Audit
Dependencies
requestrequiredHTTP client for making REST API calls to Azure Queue Storage
Agent activity
51 hits · last 30 days
node
42
Resources
azure-queue-node — npm install azure-queue-node · libregistry