@kameleoon/nodejs-event-source/README.md

Kameleoon NodeJS SDK EventSource

# Kameleoon NodeJS SDK Event Source

## Introduction

Kameleoon NodeJS SDK Event Source is a small helper package which provides default implementation for Kameleoon NodeJS SDK external Event Source built on top of NodeJS `eventsource` library.

For more information refer to [Official Kameleoon Documentation](https://developers.kameleoon.com/nodejs-sdk.html)

## Contents

- [Installation](#installation)
- [Configuration](#configuration)

## Installation

- **npm** - `npm install @kameleoon/nodejs-event-source`
- **yarn** - `yarn add @kameleoon/nodejs-event-source`
- **pnpm** - `pnpm add @kameleoon/nodejs-event-source`
- **bun** - `bun install @kameleoon/nodejs-event-source`

## Configuration

While using `@kameleoon/nodejs-sdk`:

- Import `KameleoonEventSource`
- Instantiate and pass it to external SDK dependencies

```ts
import { KameleoonClient } from '@kameleoon/nodejs-sdk';
import { KameleoonEventSource } from '@kameleoon/nodejs-event-source';

const client = new KameleoonClient({
  siteCode: 'my_site_code',
  credentials: {
    clientId: 'my_id',
    clientSecret: 'my_secret',
  },
  externals: {
    eventSource: new KameleoonEventSource(),
  },
});
```