@tdxvolt/volt-client-web v0.19.11

@tdxvolt/volt-client-web

This package exposes the tdxVolt API via websocket in a universal way, i.e. it will work via nodejs or in the browser.

See @tdxvolt/volt-client-grpc for direct access to the Volt API via grpc, which is only supported in nodejs.

Installation

npm install @tdxvolt/volt-client-web

Build

Most of the time it isn't necessary to build the package, as it is published as an ES module and can be used in both nodejs and browser environments. The package can be bundled using rollup if required using the following command:

npm run build

Usage

When using the volt-client-web package in a browser environment, you have the option to use the wasm build (recommended) or the pure js build. The wasm build is more efficient and faster, but requires a compatible browser. When building nodejs or react-native applications, use the pure JS version.

// Import using the wasm build
import { VoltClient } from '@tdxvolt/volt-client-web/wasm';

// Import using the pure JS build
import { VoltClient } from '@tdxvolt/volt-client-web/js';

Begin by importing the VoltClient class from the package and creating a new instance of it.

// Import the VoltClient class - note the use of the wasm build
import { VoltClient } from '@tdxvolt/volt-client-web/wasm';

// Create a new Volt client - here we use the window.WebSocket class
const client = new VoltClient();

// Load a Volt configuration from somewhere
const voltConfig = { ... };

return client.initialise(voltConfig).then(() => {
  // Use the client
  return client.GetResource({
    resource_id: voltConfig.volt.id
  })
});

Similarly, to use the pure JS build - just replace the import statement:

// Import the VoltClient class - note the use of the pure js build
import { VoltClient } from '@tdxvolt/volt-client-web/js';

// ... as above ...

When using the volt-client-web package in applications using node.js versions earlier than 22, a WebSocket class that is compatible with nodejs is required. The ws package is popular, providing a WebSocket class that is compatible with both nodejs and the browser.

// Import the VoltClient class - note the use of the pure js build
import { VoltClient } from '@tdxvolt/volt-client-web';

// Use the `ws` package to import the WebSocket class
import WebSocket from 'ws';

// Create a new Volt client - here we use the ws.WebSocket class
const client = new VoltClient(WebSocket);

// Load a Volt configuration from somewhere
const voltConfig = { ... };

return client.initialise(voltConfig).then(() => {
  // Use the client
  return client.GetResource({
    resource_id: voltConfig.volt.id
  })
});

For more examples of how to use the volt-client-web package, see the the official Volt documentation.