MDL-63044 javascript: add simple pubsub implementation
[moodle.git] / lib / amd / src / pubsub.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * A simple Javascript PubSub implementation.
18  *
19  * @module     core/pubsub
20  * @copyright  2018 Ryan Wyllie <ryan@moodle.com>
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
23 define([], function() {
25     var events = {};
27     /**
28      * Subscribe to an event.
29      *
30      * @param {string} eventName The name of the event to subscribe to.
31      * @param {function} callback The callback function to run when eventName occurs.
32      */
33     var subscribe = function(eventName, callback) {
34         events[eventName] = events[eventName] || [];
35         events[eventName].push(callback);
36     };
38     /**
39      * Unsubscribe from an event.
40      *
41      * @param {string} eventName The name of the event to unsubscribe from.
42      * @param {function} callback The callback to unsubscribe.
43      */
44     var unsubscribe = function(eventName, callback) {
45         if (events[eventName]) {
46             for (var i = 0; i < events[eventName].length; i++) {
47                 if (events[eventName][i] === callback) {
48                     events[eventName].splice(i, 1);
49                     break;
50                 }
51             }
52         }
53     };
55     /**
56      * Publish an event to all subscribers.
57      *
58      * @param {string} eventName The name of the event to publish.
59      * @param {any} data The data to provide to the subscribed callbacks.
60      */
61     var publish = function(eventName, data) {
62         if (events[eventName]) {
63             events[eventName].forEach(function(callback) {
64                 callback(data);
65             });
66         }
67     };
69     return {
70         subscribe: subscribe,
71         unsubscribe: unsubscribe,
72         publish: publish
73     };
74 });