vbstyle-event-models-js - A Pure JavaScript Port of vbstyle-event-models

Description

This library a pure JavaScript port of vbstyle-event-models, which was originally written in TypeScript. It provides a set of event handling and message routing utilities designed to be thread-safe and easy to use, and includes:

• BasicEventModel: A simple event model for registering and invoking event handlers
• MessageRouter: A singleton message router for pub/sub pattern messaging
• QueueEventScheduler: An event scheduler that processes events in a queue
• MutexLock: A simple mutex lock implementation for thread safety

Installation & Usage

Install the library using NPM (current version 1.0.1):

npm install vbstyle-event-models-js

Examples of usage are the same as the "Usage" section in vbstyle-event-models (see this link: vbstyle-event-models#usage).

API Reference

BasicEventModel

• addHandler(handler): Add an event handler
• removeHandler(handler): Remove an event handler
• raiseEvent(sender, e): Raise the event, invoking all handlers

MessageRouter

• static instance: Get the singleton instance
• async subscribe(messageType, handler): Subscribe to a message type
• async send(messageType, content): Send a message
• async unsubscribe(messageType, handler): Unsubscribe from a message type
• async clearSubscribers(messageType): Clear all subscribers for a message type
• subscriberCount: Get total number of subscribers

QueueEventScheduler

• async scheduleEvent(event): Schedule an event
• async processEvents(sender, e): Process all events
• async clearEvents(): Clear all pending events
• pendingEventCount: Get number of pending events

MutexLock

• async acquireLock(): Acquire the lock
• releaseLock(): Release the lock
• isLocked: Check if the lock is held
• waiterCount: Get number of waiters

Thread Safety

All classes in this library are designed to be thread-safe, using the MutexLock class to ensure safe access to shared resources.

License

BSD 3-Clause License