Registry / messaging / node-red-contrib-queue-gate

node-red-contrib-queue-gate

library1.5.5jsnpmunverified

A Node-RED node for controlling message flow with queueing capability, similar to simple-gate but with added queueing and release-on-demand features. Current stable version is 1.5.5. Actively maintained on GitHub. Differentiators: supports queue size limits, 'Keep newest messages' option (since v1.1.0), control commands (open/close/toggle/queue/trigger/flush/peek/drop/reset), and status refresh. Suitable for flow control and buffering in Node-RED automation pipelines.

messaging

npm install node-red-contrib-queue-gate

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NODE-RED-CONTRIB-Q

node-red-contrib-queue-gate

messagingjavascriptv1.5.5

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.

q-gate

✓ Use the Node-RED palette manager or npm install node-red-contrib-queue-gate in your Node-RED user directory.

✗ Do not require('node-red-contrib-queue-gate') directly in Node-RED flows.

This is a Node-RED node, not a regular npm module. Install via Manage Palette or npm in ~/.node-red.

Shows how to install and configure the q-gate node in Node-RED.

// This is a Node-RED node; no code snippet applicable. // Install: cd ~/.node-red && npm install node-red-contrib-queue-gate // Then add a 'q-gate' node from the palette. // Configure: set Control Topic, command strings, queue size, default state. // Use control messages with payload 'open', 'close', 'queue', 'trigger', etc.

Debug

Known issues

breakingIn version 1.1.0, the 'Keep newest messages' behavior was added. If upgrading from older versions, the queue now discards oldest by default; check your flows if you relied on the old behavior.

fix

Update to v1.1.0 or later. If you want to keep the same behavior (discard oldest), no change needed. If you want to keep newest, check the 'Keep newest messages' checkbox.

affects: <1.1.0

breakingIn version 1.4.0, control messages with numeric or boolean payload are converted to string before matching commands. Previously, they might have been ignored or caused errors.

fix

If you rely on control messages being numbers/booleans, ensure they map to the correct string commands (e.g., '1' vs 'open').

affects: >=1.4.0

deprecatedThe node uses `msg.topic` for control messages. Future versions might use a different property.

fix

Consider using a separate property like `msg.control` if the API changes.

affects: >=1.0.0

gotchaQueue size limit: when full, new messages are discarded by default. The 'Keep newest messages' option (v1.1.0+) discards the oldest instead.

fix

Set an appropriate queue size or enable 'Keep newest messages' if you want to retain the most recent.

affects: >=1.0.0

gotchaControl messages are case-insensitive but must match the configured command strings exactly in case. Default commands are lower-case.

fix

Ensure your control messages use the exact case as configured in the node settings.

affects: >=1.0.0

Errors

Common errors & fixes

Error: No such module: node-red-contrib-queue-gate

Node-RED cannot find the module because it is installed globally or in the wrong directory.

fix

Run 'npm install node-red-contrib-queue-gate' inside your Node-RED user directory (usually ~/.node-red).

TypeError: Cannot read property 'q-gate' of undefined

Trying to use the node before it is installed or after a failed installation.

fix

Install the package correctly and restart Node-RED.

Control message not recognized: [payload]

The control message payload does not match any configured command string or the command is not defined in the node.

fix

Check the command definitions in the node configuration and ensure your control message payload matches exactly (case-insensitive but must be a string).

Upgrade

Version history

1.5.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/drmibell/node-red-contrib-queue-gate ↗

packagenode-red-contrib-queue-gate ↗

homepagehttps://github.com/drmibell/node-red-contrib-queue-gate ↗