Nest Emitter

Overview

The Nest Emitter module is a robust solution crafted for developers using the NestJS framework, offering a strongly typed approach to event management. This module is particularly beneficial for those who have experienced the pain of typos in event names leading to erratic functionality. By utilizing interfaces to map event names to their respective payloads, the Nest Emitter ensures a more reliable event handling process, thus enhancing the overall efficiency of the application.

This module is seamlessly compatible with any EventEmitter that follows the NodeJS.Events interface, making it an adaptable choice for various project requirements. With its rich feature set and easy integration, developers can look forward to a significant improvement in how they manage and utilize events within their applications.

Features

• Strongly Typed Events: Declares events using interfaces, offering a strict framework that reduces the likelihood of errors due to typos in event names.
• Compatibility: Works with any EventEmitter that implements NodeJS.Events, ensuring flexibility in various application contexts.
• Event Records: Provides a clear mapping of event names to their payload types, adding clarity and improving maintainability.
• Generic Type Support: The StrictEventEmitter type allows for a custom EventEmitter type, tailored to specific application requirements.
• Easy Integration: Simple to import the NestEmitterModule into your root module, facilitating quick setup and usage.
• Helper Decorator: Includes @InjectEventEmitter() for easy access to the event emitter instance, streamlining the event handling process.
• Optional Payload Typing: Flexible event payload definitions, accommodating void events, function types, and others with ease.
• Open for Contributions: The project encourages community involvement, inviting developers to contribute and enhance the module further.