SDKNode
Node.js SDK
The Iggy Node.js SDK is a client library that allows you to interact with the Iggy API from your Node.js and TypeScript applications. It communicates with the Iggy server over TCP using the binary protocol. The repository can be found here.
Installation
npm install apache-iggyQuick start
Producer
import { Client, Partitioning } from 'apache-iggy';
const client = new Client({
transport: 'TCP',
options: {
port: 8090,
host: '127.0.0.1',
},
credentials: {
username: 'iggy',
password: 'iggy',
},
});
const messages = Array.from({ length: 10 }).map((_, i) => ({
id: i + 1,
headers: [],
payload: `message-${i + 1}`,
}));
await client.message.send({
streamId: 1,
topicId: 1,
messages,
partition: Partitioning.PartitionId(1),
});Consumer
import { Client, PollingStrategy, Consumer } from 'apache-iggy';
const client = new Client({
transport: 'TCP',
options: {
port: 8090,
host: '127.0.0.1',
},
credentials: {
username: 'iggy',
password: 'iggy',
},
});
const STREAM_ID = 1;
const TOPIC_ID = 1;
const PARTITION_ID = 1;
const polledMessages = await client.message.poll({
streamId: STREAM_ID,
topicId: TOPIC_ID,
consumer: Consumer.Single,
partitionId: PARTITION_ID,
pollingStrategy: PollingStrategy.Offset(BigInt(0)),
count: 10,
autocommit: false,
});
if (polledMessages && polledMessages.messages.length > 0) {
for (const message of polledMessages.messages) {
const payload = message.payload.toString('utf8');
console.log(`Offset: ${message.headers.offset}, Payload: ${payload}`);
}
}Examples
Working examples are available in the examples/node directory, written in TypeScript. The following example sets are included:
- getting-started - basic producer and consumer
- async - asynchronous message processing
- message-envelope - working with message envelopes
- message-headers - custom message headers
- multi-tenant - multi-tenant streaming setup
- tcp-tls - TLS-encrypted TCP connections
- stream-builder - stream builder API usage