engined-grpc

library0.0.9jsnpmunverified

engined-grpc is a gRPC service module for the engined framework, built on top of Groa.js. It provides Server and Router classes to integrate gRPC services into engined-based applications. Version 0.0.9 is the latest release, though the package appears to be in early development with no recent updates. It supports Node.js >=7.6 and uses the classic engined pattern of Manager and agents. Unlike standalone gRPC libraries, engined-grpc is specifically designed for the engined ecosystem, making it easy to add gRPC endpoints alongside other services.

devops

npm install engined-grpc

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ENGINED-GRPC

engined-grpc

devopsjavascriptv0.0.9

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.

Server

✓ import { Server } from 'engined-grpc'

✗ import enginedGrpc from 'engined-grpc'; const Server = enginedGrpc.Server;

CommonJS require: const { Server } = require('engined-grpc')

Router

✓ import { Router } from 'engined-grpc'

✗ import Router from 'engined-grpc'

Router is a named export, not default.

RouterService

✓ import { Router } from 'engined-grpc'; const RouterService = Router(options);

✗ const RouterService = require('engined-grpc').Router(options);

Router is a factory function that returns a class, not a direct class.

Starts a basic gRPC server using engined-grpc, demonstrating manager setup and agent addition.

const { Manager } = require('engined'); const { Server } = require('engined-grpc'); // Create a gRPC server service const grpcService = Server(); const main = async () => { // Create manager const manager = new Manager({ verbose: true }); // Add gRPC server agent manager.add('gRPCServer', grpcService); // Start all services await manager.startAll(); }; main().catch(console.error);

Debug

Known issues

gotchaRouter must be called with protoFiles option, otherwise gRPC handlers won't be registered.

fix

Ensure protoFiles array is provided when calling Router().

affects: all

deprecatedThe package relies on Groa.js which may be less actively maintained than alternatives like @grpc/grpc-js.

fix

Consider migrating to a more modern gRPC library if ongoing support is needed.

affects: all

gotchaNode.js engine requirement '>=7.6' suggests limited support for newer Node versions.

fix

Test on your Node version; may need to check for compatibility with async/await.

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'groa'

Missing groa dependency not installed automatically.

fix

Run 'npm install groa' to install peer dependency.

TypeError: Router is not a constructor

Wrong import style; Router is a factory function.

fix

Use 'const RouterService = Router({ protoFiles: [...] })' instead of 'new Router(...)'.

Error: groaRouter.rpc is not a function

Accessing router before proto files are loaded.

fix

Ensure protoFiles are correct and callbacks happen after initialization.

Upgrade

Version history

0.0.9latest on npm

Audit

Dependencies

groarequiredCore gRPC middleware framework used internally for router and server functionality.

enginedrequiredRequired to use the Manager and agent system for service lifecycle.

Agent activity

7 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/EnginedJS/engined-grpc ↗

packageengined-grpc ↗

homepagehttps://github.com/EnginedJS/engined-grpc#readme ↗