JSPM

kafka-provider

1.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q44042F
  • License ISC

NodeJS dataverse Kafka Provider

Package Exports

  • kafka-provider
  • kafka-provider/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (kafka-provider) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

kafka-provider

KafkaJS Facade to use in dataverse NodeJS projects

Config

Name Description
clientName The name of the Kafka client
brokers An array of Kafka brokers with their ports
connectionTimeout Timeout value (ms) for the Kafka connection. Default value is 1000ms. The package trows error if the connection takes more than this value

Usage

import KafkaClientProvider from 'kafka-provider';
import { KafkaConfig } from 'kafka-provider/src/types/kafka-config.interface';
import { Config as LoggerConfig } from 'commonjs-logger';
import {
  appName,
  kafkaBrokers,
  kafkaClientName,
  kafkaPassword,
  kafkaUserName,
  loggerLogLevel,
  loggerLogStyle,
} from '../config/config';

const config: KafkaConfig = {
  clientName: kafkaClientName,
  brokers: kafkaBrokers,
};

const loggerConfig: LoggerConfig = {
  logLevel: loggerLogLevel,
  logStyle: loggerLogStyle,
  appName: appName,
  moduleName: 'KafkaProvider',
};

const provider = new KafkaClientProvider(config, kafkaUserName, kafkaPassword, loggerConfig);

export default provider;

// Initialize connection
import kafkaClient from './providers/kafkaConnect';
await kafkaClient.initializeConnections();

// Send events
await kafkaClient.sendBatch(topicName, messages);