@lreebom/event-listener
v1.0.2
Published
A simple event listener for typescript
Downloads
8
Maintainers
Readme
A Simple Event Listener
一个简单的事件监听器,支持自定义事件类型和事件参数。
安装
npm i @lreebom/event-listener
使用
// 导入包
import EventListener from "@lreebom/event-listener";
// 继承 EventListener
class Sample extends EventListener {
// 重写 addEventListener、removeEventListener、dispatchEvent、clearEventListeners 方法
addEventListener<K extends keyof SampleEventMap>(type: K, eventListener: (event: SampleEventMap[K]) => void) {
super.addEventListener(type, eventListener);
}
removeEventListener<K extends keyof SampleEventMap>(type: K, eventListener: (event: SampleEventMap[K]) => void) {
super.removeEventListener(type, eventListener);
}
dispatchEvent<K extends keyof SampleEventMap>(type: K, event: SampleEventMap[K]) {
super.dispatchEvent(type, event);
}
clearEventListeners<K extends keyof SampleEventMap>(type?: K) {
super.clearEventListeners(type);
}
}
// 事件类型
interface SampleEventMap {
"open": string,
"close": CloseEvent,
"error": ErrorEvent,
}
// 自定义的CloseEvent事件参数
interface CloseEvent {
code: number,
reason: string,
}
const sample = new Sample();
// 事件监听
sample.addEventListener("open", event => {
console.log("open", event);
});
sample.addEventListener("close", event => {
console.log("close", event.code, event.reason);
});
sample.addEventListener("error", event => {
console.log("error", event.message);
});
// 事件触发
sample.dispatchEvent("open", "open event");
sample.dispatchEvent("close", {code: 1000, reason: "normal close"});
sample.dispatchEvent("error", new ErrorEvent("error", {message: "error message"}));