0.1.3-alpha • Published 3 months ago

@eiva/fletcher-gateway-client

Licence

LGPL-3.0-or-later

Version

0.1.3-alpha

Deps

Size

97 kB

Vulns

Weekly

Stars

Summary Dependency Versions

@eiva/fletcher-gateway-client

TypeScript client for the Fletcher WebGateway — WebSocket transport with positional row codec.

Installation

# latest stable
npm install @eiva/fletcher-gateway-client

# latest alpha
npm install @eiva/fletcher-gateway-client@alpha

Usage

import { FletcherClient } from '@eiva/fletcher-gateway-client';
import type { SchemaDescriptor } from '@eiva/fletcher-gateway-client';

const client = new FletcherClient({ url: 'ws://localhost:9090' });
await client.connect();

const schema: SchemaDescriptor = {
  fields: [
    { name: 'x', type: 'float64' },
    { name: 'y', type: 'float64' },
  ],
};

// Publish
await client.createTopic('position', schema);
await client.publish('position', schema, { x: 1.0, y: 2.0 });

// Subscribe
await client.subscribe('position', schema, (row, attachments) => {
  console.log(row.x, row.y);
});

// List topics
const topics = await client.listTopics();

client.close();

API

`FletcherClient`

Method	Description
`connect()`	Open the WebSocket connection
`createTopic(topic, schema?)`	Create a topic, optionally announcing its schema
`subscribe(topic, schema, callback)`	Subscribe to a topic
`unsubscribe(subId)`	Unsubscribe by subscription ID
`publish(topic, schema, data, attachments?)`	Publish a row to a topic
`listTopics()`	List all topics on the gateway
`close()`	Close the connection

`FletcherClientOptions`

Option	Type	Default	Description
`url`	`string`	—	WebSocket URL, e.g. `ws://localhost:9090`
`backend`	`'object' \| 'arrow'`	`'object'`	Decode backend
`reconnectDelay`	`number`	`0`	Reconnect delay in ms (0 to disable)

License

LGPL-3.0-or-later The Fletcher Authors