@jamilservices/sb-core-event-module
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

@jamilservices/sb-core-event-module

The @jamilservices/sb-core-event-module is a powerful and flexible library designed to simplify event management in your JavaScript applications. It provides functionalities to register, unregister, and manage custom events and their associated actions, making it an essential tool for developers looking to enhance event handling in their projects.

SimplyBuilder SimplyBuilder SimplyBuilder - Event Module GitHub License

🤖 Documented by Artificial Intelligence

This project takes a leap into the future of code documentation and maintenance. 🚀
All text commits, Readme details and JSDoc comments were created automatically by the advanced AI of ChatGPT, showcasing a seamless integration between human creativity and artificial intelligence.

By leveraging ChatGPT's capabilities, we've ensured that the documentation is not only comprehensive but also up-to-date with the latest standards. This collaboration marks a step forward in our pursuit of innovative solutions, making our codebase more accessible and easier to understand for developers worldwide.

Embrace the future of coding with us. 🌟

Installation

You can easily install the Event module in your project using npm, pnpm or yarn:

Using npm

npm install @jamilservices/sb-core-event-module

Using pnpm

pnpm add @jamilservices/sb-core-event-module

Using yarn

yarn add @jamilservices/sb-core-event-module

[!NOTE] This will add the @jamilservices/sb-core-event-module as a development dependency in your project.

ESM Import Module

CDN:

You can use the following CDN links to include the module:

https://cdn.skypack.dev/@jamilservices/sb-core-event-module@latest/lib/main.min.js

https://cdn.jsdelivr.net/npm/@jamilservices/sb-core-event-module@latest/lib/main.min.js

https://unpkg.com/@jamilservices/sb-core-event-module@latest/lib/main.min.js

Usage

Here's how to use the @jamilservices/sb-core-event-module in your application:

Importing the Module

import { EventModule } from '@jamilservices/sb-core-event-module';

Registering a Custom Event

EventModule.eventRegister('CUSTOM_ALERT', () => {
    alert('Custom alert triggered!');
});

Triggering a Custom Event

// Assuming you have a mechanism to trigger the event
triggerCustomEvent('CUSTOM_ALERT');

Unregistering a Custom Event

EventModule.eventUnregister('CUSTOM_ALERT');

API Documentation

The EventModule provides several key methods:

  • addEventToStore(data): Registers an event listener and stores its reference.
  • removeAllEventsFromStore(element): Removes all event listeners associated with the given element.
  • removeEventIdFromStore(data): Removes a specific event listener identified by its event ID.
  • eventRegister(name, fn): Registers a custom event type and its associated action.
  • eventUnregister(name): Unregisters a custom event type and removes its associated action.

Contribution Guidelines

Interested in contributing? We welcome your contributions to enhance the backend capabilities of @jamilservices/sb-core-event-module. Please check our Contribution Guidelines for more details.

License

@jamilservices/sb-core-event-module is available under the MIT License by @jamilservicos.

  • You are free to modify and reuse the code.
  • The original license must be included with copies of this software.
  • We encourage linking back to this repository if you use a significant portion of the source code.

Package Sidebar

Install

npm i @jamilservices/sb-core-event-module

Weekly Downloads

4

Version

1.0.3

License

MIT

Unpacked Size

21.6 kB

Total Files

7

Last publish

Collaborators

  • juliojamil