Git Product home page Git Product logo

event-emitter's Introduction

Event Emitter

npm version license npm downloads

Simple and generic JavaScript Event Emitter class for implementing the Observer Pattern.

The Observer Pattern is a behavioral design pattern where an object, known as the subject, maintains a list of dependents, known as observers, that are notified of any state changes.

The Observer Pattern is commonly used in scenarios where one part of a system needs to be notified of changes in another part without being tightly coupled to it. It promotes loose coupling between components, making it easier to maintain and extend the system.

observer-pattern-typescript-javascript

Installation

npm install tahasoft-event-emitter

Usage

import { EventEmitter } from "tahasoft-event-emitter";

Example 1: Basic Event Emission

const onStatusChange = new EventEmitter();

function updateStatus() {
  // ...
  onStatusChange.emit();
}

Somewhere else in your code, add a listener for the status change event:

onStatusChange.add(() => {
  // ...
});

Example 2: Event with Data

/** @type {!EventEmitter<!string>} */
const onStatusChange = new EventEmitter();

function updateStatus(status) {
  // ...
  onStatusChange.emit(status);
}

Add a listener with data for the status change event:

onStatusChange.add(status => {
  // ... (status is a string)
});

Example 3: Using in a Class

class User {
  constructor() {
    this.status = "";

    /** @type {!EventEmitter<!string>} */
    this.onStatusChange = new EventEmitter();
  }

  updateStatus(status) {
    this.status = status;
    onStatusChange.emit(status);
  }
}

const user = new User();
user.onStatusChange.add(status => {
  // do something
});

Example 4: TypeScript Usage

class User {
  public onLogin = new EventEmitter<string>();

  public login(userName: string, password: string) {
    // validate username and password
    this.onLogin.emit(userName);
  }

  public logout() {
    // logout
    this.onLogin.removeAllListeners();
  }
}

const user = new User();

user.onLogin.add((name: string) => {
  console.log(`User ${name} has logged in`);
});

user.login("John", "1234abcd");

Methods

To add a listener, you can use any of the following:

add(listener);
addListener(listener);
addEventListener(listener);
subscribe(listener);

Remove a listener using any of the following:

remove(listener);
removeListener(listener);
removeEventListener(listener);
unsubscribe(listener);

To remove all listeners

removeAllListeners();

Execute each of the listeners in order with the supplied arguments:

emit(args);
dispatch(args);

The args parameter is optional and represents the arguments to be passed to the listeners.

event-emitter's People

Contributors

zt-wizkids-tech avatar zuhairtaha avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.