Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.16 KB

README.md

File metadata and controls

86 lines (60 loc) · 3.16 KB
Raw

Welcome to One Dionys - Event Emitter! 👋

Packages to implement the Observer pattern, enabling communication between application components. 💖

💾 Requirements

  • Web Browser - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
  • Internet - Because many use CDN and to make it easier to find solutions to all problemss.

🎯 How To Use

Example Syntax

// Import EventEmitter from the package
const EventEmitter = require('./src/EventEmitter');

// Create an instance of EventEmitter
const emitter = new EventEmitter();

// Define a listener function
const listener = (data) => {
  console.log('Event triggered with data:', data);
};

// Register the listener for the 'customEvent' event
emitter.on('customEvent', listener);

// Emit the 'customEvent' event with some data
emitter.emit('customEvent', 'Hello, World!');

// Remove the listener for the 'customEvent' event
emitter.off('customEvent', listener);

Explanation

  • The "Event Emitter" package has three main methods: on, emit, and off.
  • The on method is used to add a listener to an event.
  • The emit method is used to emit an event with optional parameters.
  • The off method is used to remove the listener from an event.

Return Value

  • The on and off methods do not return a specific value.
  • The emit method does not return a value and is only used to trigger the event.

📆 Release Date

  • v1.0.0 : 07 March 2024
  • v1.0.1 : 11 March 2024
  • v4.0.0 : 11 March 2024
  • v4.0.1 : 11 March 2024
  • v4.0.2 : 13 March 2024
  • v4.0.3 : 18 March 2024
  • v5.0.0 : 31 March 2024

🧑 Author

📝 License

  • Copyright © 2024 One Dionys
  • One Dionys - Event Emitter is an open source project licensed under the MIT license

☕️ Suppport & Donation

Love One Dionys - Event Emitter? Support this project by donating or sharing with others in need.

Made with ❤️ One Dionys