Registry / integration / node-red-contrib-grpc

node-red-contrib-grpc

library1.2.5jsnpmunverified

A gRPC wrapper for Node-RED providing both server and client nodes (grpc-server, grpc-register-function, grpc-response, grpc-call). Version 1.2.5 is the latest stable release as of 2024, with moderate release cadence. It allows building gRPC services within Node-RED flows, supporting protocol buffer definitions and bidirectional streaming. Key differentiator: no custom coding required for gRPC integration within Node-RED, unlike using raw grpc-js packages.

integration

npm install node-red-contrib-grpc

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NODE-RED-CONTRIB-G

node-red-contrib-grpc

integrationjavascriptv1.2.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Shows how to install and use the gRPC server and client nodes within Node-RED.

// No JavaScript imports; nodes are used in Node-RED flows. // Example flow JSON can be imported into Node-RED. // The following command installs the package: // npm install node-red-contrib-grpc // To use, add grpc-server node with proto definition, grpc-register-function for server methods, // grpc-response to send replies, and grpc-call for client calls.

Debug

Known issues

breakingRequires Node.js 12+ and Node-RED 1.x+. Older versions may break.

fix

Update Node.js to 12+ and Node-RED to 1.x+.

affects: >=1.0.0

gotchaProto files must be defined inline in the grpc-server node configuration; external file references are not supported.

fix

Paste the complete proto definition into the protoFile field of the grpc-server node.

affects: all

gotchaDead code paths: The grpc-call node sends requests but does not handle streaming responses; only unary calls are supported.

fix

Use grpc-call only for unary calls; implement custom streaming nodes if needed.

affects: <=1.2.5

Errors

Common errors & fixes

Error: Cannot find module '@grpc/grpc-js'

@grpc/grpc-js not installed due to missing peer dependencies.

fix

Run 'npm install @grpc/grpc-js @grpc/proto-loader' in your Node-RED directory.

Error: gRPC server not starting: EADDRINUSE

Port already in use; another instance is running on the same port.

fix

Stop the conflicting service or change the port in the grpc-server node configuration.

Syntax error in proto file

Proto file content is malformed or missing required fields.

fix

Verify the proto definition syntax (e.g., correct semicolons, package name, service/message definitions).

Upgrade

Version history

1.2.5latest on npm

Audit

Dependencies

@grpc/grpc-jsrequiredCore gRPC runtime used for client and server implementation

@grpc/proto-loaderrequiredRequired for loading .proto files dynamically

Agent activity

45 hits · last 30 days

node

Resources

githubhttps://github.com/julien-pal/node-red-contrib-grpc ↗

packagenode-red-contrib-grpc ↗

homepagehttps://github.com/julien-pal/node-red-contrib-grpc#readme ↗