ddbes v0.25.2

ddbes

DynamoDB Event Store

WARNING

You should probably not be using this unless you are familiar with event sourcing and willing to read and understand the code.

Table of contents

• Features
• Installation
• Usage
• API docs
• Development

Features

• Modern and convenient interface for using DynamoDB as an event store
• S3 snapshots (for aggregates with many commits)
• Upcasters and lazy transformation
• WebSocket server and client for event subscriptions (e.g. for providing graphql subscriptions)
• Helpers for managing dynamodb tables (incl. auto scaling)
• Efficient store querying and mutation

Installation

yarn add ddbes

A minimum of node 6.5.0 is required. If used with >=9.0.0 and --harmony, the non-transpiled version with native async generators etc is used.

API docs

TODO

Development

Starting development environment

# Bring up a local dynamodb and s3, as well as running tests and linting every time the code changes.

docker-compose up --build

Running tests across all node targets

# Assumes the development environment is running

docker-compose exec dev yarn test

Publishing new version

# Assumes the development environment is running

docker-compose exec dev scripts/publish