Event Queue Processor

Event Queue Processor is a JavaScript library for client-side event batching and processing.

Table of Contents

• Installation
• API Reference
• Example
• Contributor Guidelines

Installation

Install the library using npm:

npm install event-queue-processor

API Reference

You can configure the EventQueueProcessor by providing options during initialization. The available options include:

• batchInterval (default: 5000): The time interval (in milliseconds) between batches.
• maxRetries (default: 3): The maximum number of retry attempts for failed batches.
• batchSize (default: 5): The maximum number of events to include in a batch.
• serverRequest (default: _fakeServerRequest): The function responsible for sending events to the server.

addEventToQueue(event, priority)

The addEventToQueue method is used to add events to the event batch queue. You can call this method to enqueue events for later batch processing. The method takes two parameters:

• event: The event object that you want to add to the batch. This can be any valid JavaScript object representing an event.
• priority (optional): A boolean flag indicating whether the added event has priority. If set to true, the batch will be immediately sent to the server, bypassing the regular batch interval and size constraints.

Example

const EventQueueProcessor = require('event-queue-processor');

const options = {
    batchInterval: 3000,
    maxRetries: 5,
    batchSize: 10
};

// Create an instance of EventQueueProcessor
const eventQueueProcessor = new EventQueueProcessor(options);


// Add events to the batch
eventQueueProcessor.addEventToQueue({ type: 'click', target: 'button' }, true);
eventQueueProcessor.addEventToQueue({ type: 'hover', target: 'element' }, false);

// Simulate adding events during processing
setTimeout(() => {
    eventQueueProcessor.addEventToQueue({ type: 'scroll', target: 'window' });
    eventQueueProcessor.addEventToQueue({ type: 'keydown', target: 'input' });
}, 2000);

Contributor Guidelines

Branching Strategy

We use the GitHub flow for our branching model.

Setting Up the Development Environment

To set up your local development environment, follow these steps:

1. Clone the repository.
2. Install dependencies with npm install.

Bug Reports and Feature Requests

Please submit bug reports and feature requests through our issue tracker.

Pull Request Guidelines

1. Fork the repository and create a new branch.

Contribution Recognition

Contributors will be acknowledged in the project documentation and release notes.

Thank you for contributing to our project!