@eventstore/db-客户端
这是用于事件StoreDB 20+的NodeJS客户端的软件包,并使用gRPC作为通信协议.
安装
# Yarn
$ yarn add @eventstore/db-client
# NPM
$ npm install --save @eventstore/db-client
事件StoreDB 服务器兼容性
此客户端与版本兼容 20.6.1 向上移动.
服务器设置指令可见于该软件的安装部分 事件存储文档。跟踪最简单配置的多克设置.
示例
以下片段展示了一个简单的例子,我们在那里组成连接,然后附加并读取服务器上的事件.
Javascript 示例 :
const {
EventStoreDBClient,
jsonEvent,
FORWARDS,
START,
} = require('@eventstore/db-client');
const client = new EventStoreDBClient({
endpoint: "localhost:2113",
});
async function simpleTest() {
const streamName = "es_supported_clients";
const event = jsonEvent({
type: "grpc-client",
data: {
languages: ["typescript", "javascript"],
runtime: "NodeJS",
},
});
const appendResult = await client.appendToStream(streamName, [event]);
// read the event
const events = client.readStream(streamName, {
fromRevision: START,
direction: FORWARDS,
maxCount: 10,
});
for await (const { event } of events) {
console.log('Appended event: ', event);
}
} catch (error) {
console.error('An error occured: ', error);
} finally {
await client.dispose();
}
})();
键入符示例 :
import {
EventStoreDBClient,
jsonEvent,
FORWARDS,
START,
JSONEventType,
} from '@eventstore/db-client';
const client = new EventStoreDBClient({
endpoint: 'localhost:2113',
});
interface Reservation {
reservationId: string;
movieId: string;
userId: string;
seatId: string;
}
type SeatReservedEvent = JSONEventType<
'seat-reserved',
{
reservationId: string;
movieId: string;
userId: string;
seatId: string;
}
>;
type SeatChangedEvent = JSONEventType<
'seat-changed',
{
reservationId: string;
newSeatId: string;
}
>;
type ReservationEvents = SeatReservedEvent | SeatChangedEvent;
async function simpleTest(): Promise<void> {
const streamName = 'booking-abc123';
const event = jsonEvent<SeatReservedEvent>({
type: 'seat-reserved',
data: {
reservationId: 'abc123',
movieId: 'tt0368226',
userId: 'nm0802995',
seatId: '4b',
},
});
const appendResult = await client.appendToStream<ReservationEvents>(
streamName,
event
);
// By reading the events in the stream, we can construct the current state of the booking
interface Reservation {
reservationId: string;
movieId: string;
userId: string;
seatId: string;
}
const events = client.readStream<ReservationEvents>(streamName, {
fromRevision: START,
direction: FORWARDS,
maxCount: 10,
});
const reservation: Partial<Reservation> = {};
for await (const { event } of events) {
switch (event.type) {
case 'seat-reserved': {
reservation.reservationId = event.data.reservationId;
reservation.movieId = event.data.movieId;
reservation.seatId = event.data.seatId;
reservation.userId = event.data.userId;
break;
}
case 'seat-changed': {
reservation.seatId = event.data.newSeatId;
break;
}
default: {
const _exhaustiveCheck: never = event;
break;
}
}
}
}
// Do something with our reservation
console.log(reservation);
支助
关于支助的信息可在我们的网站上查阅: 事件存储支持
社区
捐款
参考我们 贡献准则