depi-node-client

DEPI NodeJS Client

Generating source files from .proto

Install dependencies:

npm install

# Apple M1 users should install for x64 due to grpc-tools not supporting arm64
npm install --target_arch=x64

Use proto compiler and ts-protoc-gen to generate the TypeScript files:

Important! This needs to be executed from the directory where this file is.

npm run build

To use the async API for the client. Including the following snippet when creating the depi-client instance. These *Async methods are generate in the d.ts by generateAsyncTypes.js which is run as part of the build.

    const { DepiClient } = require('./pbs/depi_grpc_pb');
    const addAsyncMethods = require('./pbs/addAsyncMethods');

    const client = new DepiClient('127.0.0.1:5150', grpc.credentials.createInsecure());
    addAsyncMethods(client);

    // Example using the async/promise methods,
    const req = new depi.LoginRequest();
    const loginResponse = await client.loginAsync(req);

Publish a Release

(Make sure to npm run build and check it's up-to-date). Also if adding a function in depi-utils - don't forget to add it to the default export!

1. npm run compile
2. Update to a new version (x.x.x) in package.json
3. git commit -am "Node-client release x.x.x"
4. git push origin main
5. npm publish ./