Skip to content

saffron-db-ts-client 0.0.1-849194c

Install from the command line:
Learn more about npm packages
$ npm install @o1-labs/saffron-db-ts-client@0.0.1-849194c
Install via package.json:
"@o1-labs/saffron-db-ts-client": "0.0.1-849194c"

About this version

saffron-db-ts-client

This directory contains the TypeScript client library for the saffron-db service. The goal is to match the capability of the rust version found in saffron-db-client.

Prerequisites

Before building the client, ensure you have the necessary Rust WASM tools installed:

make install-rust-wasm-tools

Build

The TypeScript client now integrates WASM building directly into its build process. Simply run:

npm install
npm run build

This will:

  1. Build the WASM bindings from the Rust code in the wasm directory
  2. Copy in the SRS from the srs-cache
  3. Build and output the WASM files to a pkg directory
  4. Compile the TypeScript code

You can also use the Makefile command which does the same:

make build-ts-client

Testing

Once you have built the client (and assuming you are running the saffron-db service), you can run the TypeScript e2e tests via:

npm test
# or
make test-ts-client

NOTE: currently the ts client e2e tests attempt to pull in the SRS file from the srs-cache directory. If you do not have this, follow the instructions there to retrieve it.

Details


Assets

  • saffron-db-ts-client-0.0.1-849194c.tgz

Download activity

  • Total downloads 1
  • Last 30 days 0
  • Last week 0
  • Today 0