grpc-mock

library0.7.0jsnpmunverified

grpc-mock is a simple mock gRPC server for Node.js, providing a declarative API for defining request-response rules and streaming behaviors. It supports unary, client-streaming, server-streaming, and bidirectional streaming RPCs, as well as error simulation. Version 0.7.0 is the latest release; the package is stable but not frequently updated. It relies on grpc-kit and @grpc/proto-loader for loading .proto files and creating servers. Key differentiators: lightweight, rule-based matching with regex support, and simple stream chunk configuration.

testing

npm install grpc-mock

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GRPC-MOCK

grpc-mock

testingjavascriptv0.7.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.

createMockServer

✓ import { createMockServer } from 'grpc-mock'

✗ const grpcMock = require('grpc-mock')

Named export since v0.7; no default export

createMockServer

✓ const { createMockServer } = require('grpc-mock')

✗ const createMockServer = require('grpc-mock')

CommonJS destructuring required; grpc-mock exports an object

Creates a mock gRPC server with a single unary rule and listens on port 50051.

import { createMockServer } from 'grpc-mock'; const mockServer = createMockServer({ protoPath: 'path/to/greeter.proto', packageName: 'greeter', serviceName: 'Greeter', rules: [{ method: 'hello', input: { message: 'test' }, output: { message: 'Hello' } }] }); mockServer.listen('0.0.0.0:50051'); console.log('Mock server running on 0.0.0.0:50051');

Debug

Known issues

breakingIn v0.7.0, the library switched to named exports; default export removed.

fix

Use `import { createMockServer } from 'grpc-mock'` or `const { createMockServer } = require('grpc-mock')`.

affects: >=0.7.0

deprecatedThe `options` parameter for proto loader options is deprecated; use a separate @grpc/proto-loader configuration.

fix

Set `options` to `null` and pass options to `@grpc/proto-loader` directly if needed.

affects: >=0.7.0

gotchaWhen using streaming, the `streamType` property must be explicitly set; omitting it defaults to null (unary).

fix

Always set `streamType` to 'client', 'server', or 'mutual' for streaming rules.

affects: >=0.0.0

Errors

Common errors & fixes

TypeError: grpcMock is not a function

Default import style used for a module that only exports named exports.

fix

Use `import { createMockServer } from 'grpc-mock'`.

Error: Cannot find module 'grpc-kit'

Missing peer dependency `grpc-kit` which is required at runtime.

fix

Run `npm install grpc-kit`.

Upgrade

Version history

0.7.0latest on npm

Audit

Dependencies

grpc-kitrequiredunderlying gRPC server implementation

Agent activity

15 hits · last 30 days

node

Resources

githubhttps://github.com/YoshiyukiKato/grpc-mock ↗

packagegrpc-mock ↗

homepagehttps://github.com/YoshiyukiKato/grpc-mock#readme ↗