@atomstate/atomstate-client v1.1.1

Atomstate-JS: JavaScript Atomstate SDK

This package represents the JS SDK for the Atomstate vector search engine.

The next packages are re-exported from it:

• JS Client REST
• JS Client gRPC

Installation

yarn i @atomstate/atomstate-client
# or
npm install @atomstate/atomstate-client
# or
yarn add @atomstate/atomstate-client

Usage

The REST client is imported from the root path; the gRPC is imported from the /grpc subpath:

import {AtomstateClient} from '@atomstate/atomstate-client'; // REST client

import {AtomstateClient} from '@atomstate/atomstate-client/grpc'; // gRPC client

Begin with the REST (OpenAPI-based) client for easier debugging. Once your APIs are stable, switch to gRPC for better performance. Remember, REST can match or surpass gRPC for smaller requests, while gRPC is more efficient for larger data transfers.

Contributing

These are the most relevant scripts for development:

• yarn build: builds and bundles from TypeScript sources
• yarn pre-check: type-checks sources
• yarn pre-commit: same as pre-check, but for git hooks (husky)