Registry / storage / grpc-event-store

grpc-event-store

JSON →
library1.0.0jsnpmunverified

An Event Store implementation exposing a gRPC interface for event sourcing. Current version 1.0.0. This package provides a Node.js client for an event store with gRPC communication, designed for event sourcing patterns. It requires Docker and Docker Compose for development and testing. Differentiators include a gRPC-based interface for type-safe, cross-language communication, and integration with gRPC ecosystem tools.

npm install grpc-event-store
INSTALL
IMPORT
SIG · GRPC-EVENT-STORE
G
grpc-event-store
storagejavascriptv1.0.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.

EventStoreClient
import { EventStoreClient } from 'grpc-event-store';
const EventStoreClient = require('grpc-event-store').EventStoreClient;
Named export; requires ESM import or destructured require.
Event
import { Event } from 'grpc-event-store';
import Event from 'grpc-event-store';
Not default export; use named import.
EventStoreClient (default)
import EventStoreClient from 'grpc-event-store';
const EventStoreClient = require('grpc-event-store');
Default export is also available for convenience.

Shows how to instantiate the client, append an event to a stream, and read events back.

import { EventStoreClient } from 'grpc-event-store'; async function main() { const client = new EventStoreClient('localhost:50051'); const event = { id: '123', type: 'UserCreated', data: Buffer.from(JSON.stringify({ name: 'Alice' })), }; await client.appendEvent('stream-1', event); const events = await client.readEvents('stream-1'); console.log(events); } main().catch(console.error);
Debug
Known issues
gotchaThe package has no TypeScript typings bundled; you may need to install @types/grpc-event-store separately.
fix
Install @types/grpc-event-store from DefinitelyTyped.
affects: >=1.0.0
deprecatedThe .proto files require proto-loader v0.5.x compatibility; newer versions may break.
fix
Pin @grpc/proto-loader to ^0.5.0.
affects: >=1.0.0
breakingVersion 1.0.0 uses @grpc/grpc-js instead of grpc package; existing code from pre-release versions may break.
fix
Update imports to use @grpc/grpc-js.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'grpc'
Version 1.0.0 switched from 'grpc' to '@grpc/grpc-js' but some transitive dependencies still expect 'grpc'.
fix
Ensure you have @grpc/grpc-js installed and update any references from 'grpc' to '@grpc/grpc-js'.
TypeError: grpc.loadPackageDefinition is not a function
Using an incompatible version of @grpc/proto-loader; the package expects the older API.
fix
Install @grpc/proto-loader@0.5.6 and check compatibility.
Error: 14 UNAVAILABLE: failed to connect to all addresses
gRPC server not running or incorrect address provided.
fix
Verify the server is running on the address specified (default localhost:50051).
Upgrade
Version history
1.0.0latest on npm
Audit
Dependencies
@grpc/grpc-jsrequiredRequired for gRPC client implementation
@grpc/proto-loaderrequiredNeeded to load .proto files for gRPC service definitions
Agent activity
13 hits · last 30 days
node
12
OpenAI (training)
1
Resources
grpc-event-store — npm install grpc-event-store · libregistry