mirror of
https://github.com/codex-team/editor.js
synced 2024-05-03 07:03:47 +02:00
3272efc3f7
* update eslint + autofix * a bunch of eslint fixes * some spelling & eslint fixes * fix some eslint errors and spells * Update __module.ts * a bunch of eslint fixes in tests * Update cypress.yml * Update cypress.yml * fix cypress docker image name * fixes for tests * more tests fixed * rm rule ignore * rm another ignored rule * Update .eslintrc
105 lines
2.8 KiB
TypeScript
105 lines
2.8 KiB
TypeScript
import { isEmpty } from '../utils';
|
|
|
|
/**
|
|
* @class EventDispatcher
|
|
*
|
|
* Has two important methods:
|
|
* - {Function} on - appends subscriber to the event. If event doesn't exist - creates new one
|
|
* - {Function} emit - fires all subscribers with data
|
|
* - {Function off - unsubscribes callback
|
|
* @version 1.0.0
|
|
* @typedef {Events} Events
|
|
* @property {object} subscribers - all subscribers grouped by event name
|
|
*/
|
|
export default class EventsDispatcher<Events extends string = string> {
|
|
/**
|
|
* Object with events` names as key and array of callback functions as value
|
|
*
|
|
* @type {{}}
|
|
*/
|
|
private subscribers: {[name: string]: Array<(data?: object) => unknown>} = {};
|
|
|
|
/**
|
|
* Subscribe any event on callback
|
|
*
|
|
* @param {string} eventName - event name
|
|
* @param {Function} callback - subscriber
|
|
*/
|
|
public on(eventName: Events, callback: (data: object) => unknown): void {
|
|
if (!(eventName in this.subscribers)) {
|
|
this.subscribers[eventName] = [];
|
|
}
|
|
|
|
// group by events
|
|
this.subscribers[eventName].push(callback);
|
|
}
|
|
|
|
/**
|
|
* Subscribe any event on callback. Callback will be called once and be removed from subscribers array after call.
|
|
*
|
|
* @param {string} eventName - event name
|
|
* @param {Function} callback - subscriber
|
|
*/
|
|
public once(eventName: Events, callback: (data: object) => unknown): void {
|
|
if (!(eventName in this.subscribers)) {
|
|
this.subscribers[eventName] = [];
|
|
}
|
|
|
|
const wrappedCallback = (data: object): unknown => {
|
|
const result = callback(data);
|
|
|
|
const indexOfHandler = this.subscribers[eventName].indexOf(wrappedCallback);
|
|
|
|
if (indexOfHandler !== -1) {
|
|
this.subscribers[eventName].splice(indexOfHandler, 1);
|
|
}
|
|
|
|
return result;
|
|
};
|
|
|
|
// group by events
|
|
this.subscribers[eventName].push(wrappedCallback);
|
|
}
|
|
|
|
/**
|
|
* Emit callbacks with passed data
|
|
*
|
|
* @param {string} eventName - event name
|
|
* @param {object} data - subscribers get this data when they were fired
|
|
*/
|
|
public emit(eventName: Events, data?: object): void {
|
|
if (isEmpty(this.subscribers) || !this.subscribers[eventName]) {
|
|
return;
|
|
}
|
|
|
|
this.subscribers[eventName].reduce((previousData, currentHandler) => {
|
|
const newData = currentHandler(previousData);
|
|
|
|
return newData || previousData;
|
|
}, data);
|
|
}
|
|
|
|
/**
|
|
* Unsubscribe callback from event
|
|
*
|
|
* @param {string} eventName - event name
|
|
* @param {Function} callback - event handler
|
|
*/
|
|
public off(eventName: Events, callback: (data: object) => unknown): void {
|
|
for (let i = 0; i < this.subscribers[eventName].length; i++) {
|
|
if (this.subscribers[eventName][i] === callback) {
|
|
delete this.subscribers[eventName][i];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Destroyer
|
|
* clears subscribers list
|
|
*/
|
|
public destroy(): void {
|
|
this.subscribers = null;
|
|
}
|
|
}
|