@jalik/observer

@jalik/observer

The classic observer design pattern.

Introduction

The Observer design pattern is a well known pattern to create reactive applications. For example, your can attach observers to a form text field, then when the text field value changes, all observers are notified of that change and thus can do something in response.

Attaching an observer and notify it

The following code shows how to attach an observer and how to notify it of events.

import Observer from "@jalik/observer";

class Person {
    constructor(name) {
        this.name = name;
        // Create the observer with current context
        this.observer = new Observer(this);
    }
    
    on(event, observer) {
        // Attach observer
        this.observer.attach(event, observer);
    }
    
    say(words) {
        // Notify observers
        this.observer.notify("say", words, new Date());
    }
}

const karl = new Person("karl");

// When this person says something,
// we will display it in the console with the time
karl.on("say", function(words, date) {
    console.log(`${this.name} said: "${words}" at ${date.toString()}`);
});

Detaching an observer

In the case that you need to remove a previously attached observer, here is the code.

import Observer from "@jalik/observer";

const doubleClickListener = function() {
    console.log("double click detected");
    // This avoid the current function to be called
    // on the next "doubleClick" event notification.
    observer.detach("doubleClick", doubleClickListener);
};

const observer = new Observer();
observer.attach("doubleClick", doubleClickListener);

// This will call the doubleClickListener once.
observer.notify("doubleClick");

// This will not call the doubleClickListener
// since it has been detached in the previous call.
observer.notify("doubleClick");

Changelog

History of releases is in the changelog.

License

The code is released under the MIT License.

If you find this lib useful and would like to support my work, donations are welcome :)

Changelog

v1.1.9 (2020-11-10)

• Added esnext and sideEffects in package.json
• Renamed observer.js to Observer.js
• Upgraded dependencies