Fluvio TypeScript / NodeJS Client

Overview

The NodeJS client for communicating with Fluvio clusters.

Example Construction

import Fluvio, { RecordSet } from '@fluvio/client';

// define the name of the topic to use
const TOPIC_NAME = "my-topic"

// define the partition where the topic
// records will be stored;
const PARTITION = 0

// Instantiate a new fluvio client
const fluvio = new Fluvio({
 host: '127.0.0.1',
 port: 9003
});

// Explicitly connect to the fluvio cluster;
await fluvio.connect();

//// Fluvio Admin Client

// Create a new Fluvio Admin Client to manage
// topics and partitions
const admin = await fluvio.admin();

// Create a new topic
await admin.createTopic(TOPIC_NAME)

//// Topic Producer

// Create a topic producer for the topic;
const producer = await fluvio.topicProducer(TOPIC_NAME);

// Send a new topic record
producer.sendRecord("stringified data", PARTITION)

//// Partition Consumer

// Instantiate a new topic listener;
const consumer = await fluvio.partitionConsumer(TOPIC_NAME, PARTITION)

// Listen for new topics sent by a topic producer;
await consumer.listen(async (data: RecordSet) => {
  // handle data record
})

Uses Node Native Modules

TypeScript wrapper around native fluvio core module written in Rust.

Core module is generated from node-bindgen. This TypeScript wrapper provides type definitions and generates the JavaScript client.