⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

The TypeScript SDK for the Reduction streaming engine

Notifications You must be signed in to change notification settings

reduction-dev/reduction-ts

Repository files navigation

Reduction TypeScript SDK

This is the official TypeScript client for the Reduction streaming engine.

Installation

Reduction currently runs best with bun.

# Using bun (recommended)
bun add reduction-ts

# Using npm
npm install --save reduction-ts

Then take a look at the Getting Started guide.

Developing the SDK

Developing against reduction-protocol

This project uses protocol definitions from the sibling reduction-protocol repository to generate TypeScript code.

  1. Ensure you have the reduction-protocol repository cloned at ../reduction-protocol (sibling directory to this project)
  2. Run code generation: ./scripts/gen
  3. Generated files will be placed in src/proto/ and contain version information in src/proto/VERSION
  4. Generated TypeScript files should be committed to the repository.

Releasing a new version

npm version patch
git push

About

The TypeScript SDK for the Reduction streaming engine

Resources

Stars

Watchers

Forks

Packages

No packages published