-
-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
49 changed files
with
24,566 additions
and
57 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
292 changes: 292 additions & 0 deletions
292
release/1.22.2/doc/node_modules_@scena_event-emitter_src_EventEmitter.ts.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,292 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>node_modules/@scena/event-emitter/src/EventEmitter.ts - Documentation</title> | ||
|
||
<script src="scripts/prettify/prettify.js"></script> | ||
<script src="scripts/prettify/lang-css.js"></script> | ||
<!--[if lt IE 9]> | ||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> | ||
<![endif]--> | ||
<link type="text/css" rel="stylesheet" href="styles/prettify.css"> | ||
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> | ||
<link type="text/css" rel="stylesheet" href="styles/daybrush.css"> | ||
<link type="text/css" rel="stylesheet" href="styles/custom.css"> | ||
<meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"> | ||
<meta name="description" content="node_modules/@scena/event-emitter/src/EventEmitter.ts - Documentation"/> | ||
|
||
</head> | ||
<body> | ||
|
||
<input type="checkbox" id="nav-trigger" class="nav-trigger" /> | ||
<label for="nav-trigger" class="navicon-button x"> | ||
<div class="navicon"></div> | ||
</label> | ||
|
||
<label for="nav-trigger" class="overlay"></label> | ||
|
||
<nav> | ||
<h2><a href="index.html">Home</a></h2><h2 class="custom"><a href="https://github.com/daybrush/selecto" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><div class="search"><div class="input-area"><input type="text"/></div><button></button></div><ul class="classes"><li file="selecto" class="parent"><a href="Selecto.html">Selecto</a><h4><a href="Selecto.html#static members">Static Members</a></h4><ul class='static members'><li data-type='member'><a href="Selecto.html#.CLASS_NAME">CLASS_NAME</a></li><li data-type='member'><a href="Selecto.html#.EVENTS">EVENTS</a></li><li data-type='member'><a href="Selecto.html#.METHODS">METHODS</a></li><li data-type='member'><a href="Selecto.html#.OPTIONS">OPTIONS</a></li></ul><h4><a href="Selecto.html#methods">Methods</a></h4><ul class='methods'><li data-type='method'><a href="Selecto.html#checkScroll">checkScroll</a></li><li data-type='method'><a href="Selecto.html#clickTarget">clickTarget</a></li><li data-type='method'><a href="Selecto.html#destroy">destroy</a></li><li data-type='method'><a href="Selecto.html#emit">emit</a></li><li data-type='method'><a href="Selecto.html#findSelectableTargets">findSelectableTargets</a></li><li data-type='method'><a href="Selecto.html#getSelectableElements">getSelectableElements</a></li><li data-type='method'><a href="Selecto.html#getSelectedTargets">getSelectedTargets</a></li><li data-type='method'><a href="Selecto.html#off">off</a></li><li data-type='method'><a href="Selecto.html#on">on</a></li><li data-type='method'><a href="Selecto.html#once">once</a></li><li data-type='method'><a href="Selecto.html#selectTargetsByPoints">selectTargetsByPoints</a></li><li data-type='method'><a href="Selecto.html#setSelectedTargets">setSelectedTargets</a></li><li data-type='method'><a href="Selecto.html#setSelectedTargetsByPoints">setSelectedTargetsByPoints</a></li><li data-type='method'><a href="Selecto.html#trigger">trigger</a></li><li data-type='method'><a href="Selecto.html#triggerDragStart">triggerDragStart</a></li></ul><h4><a href="Selecto.html#events">Events</a></h4><ul class='events'><li data-type='event'><a href="Selecto.html#.event:drag">drag</a></li><li data-type='event'><a href="Selecto.html#.event:dragEnd">dragEnd</a></li><li data-type='event'><a href="Selecto.html#.event:dragStart">dragStart</a></li><li data-type='event'><a href="Selecto.html#.event:keydown">keydown</a></li><li data-type='event'><a href="Selecto.html#.event:keyup">keyup</a></li><li data-type='event'><a href="Selecto.html#.event:select">select</a></li><li data-type='event'><a href="Selecto.html#.event:selectEnd">selectEnd</a></li><li data-type='event'><a href="Selecto.html#.event:selectStart">selectStart</a></li></ul><h4><a href="Selecto.html#type definitions">Type Definitions</a></h4><ul class='type definitions'><li data-type='typddef'><a href="Selecto.html#.BoundContainer">BoundContainer</a></li><li data-type='typddef'><a href="Selecto.html#.CurrentTarget">CurrentTarget</a></li><li data-type='typddef'><a href="Selecto.html#.OnDrag">OnDrag</a></li><li data-type='typddef'><a href="Selecto.html#.OnDragEnd">OnDragEnd</a></li><li data-type='typddef'><a href="Selecto.html#.OnDragStart">OnDragStart</a></li><li data-type='typddef'><a href="Selecto.html#.OnSelect">OnSelect</a></li><li data-type='typddef'><a href="Selecto.html#.OnSelectEnd">OnSelectEnd</a></li><li data-type='typddef'><a href="Selecto.html#.SelectedTargets">SelectedTargets</a></li><li data-type='typddef'><a href="Selecto.html#.SelectedTargetsWithRect">SelectedTargetsWithRect</a></li><li data-type='typddef'><a href="Selecto.html#.SelectoOptions">SelectoOptions</a></li></ul></li><li file="eventemitter" class="parent"><a href="EventEmitter.html">EventEmitter</a><h4><a href="EventEmitter.html#methods">Methods</a></h4><ul class='methods'><li data-type='method'><a href="EventEmitter.html#emit">emit</a></li><li data-type='method'><a href="EventEmitter.html#off">off</a></li><li data-type='method'><a href="EventEmitter.html#on">on</a></li><li data-type='method'><a href="EventEmitter.html#once">once</a></li><li data-type='method'><a href="EventEmitter.html#trigger">trigger</a></li><li data-type='method'><a href="EventEmitter.html#trigger">trigger</a></li></ul><h4><a href="EventEmitter.html#type definitions">Type Definitions</a></h4><ul class='type definitions'><li data-type='typddef'><a href="EventEmitter.html#.EmitterParam">EmitterParam</a></li><li data-type='typddef'><a href="EventEmitter.html#.EventHash">EventHash</a></li><li data-type='typddef'><a href="EventEmitter.html#.EventInfo">EventInfo</a></li><li data-type='typddef'><a href="EventEmitter.html#.EventListener">EventListener</a></li><li data-type='typddef'><a href="EventEmitter.html#.EventOptions">EventOptions</a></li><li data-type='typddef'><a href="EventEmitter.html#.OnEvent">OnEvent</a></li><li data-type='typddef'><a href="EventEmitter.html#.TargetParam">TargetParam</a></li></ul></li></ul> | ||
</nav> | ||
|
||
<div id="main"> | ||
|
||
<h1 class="page-title">node_modules/@scena/event-emitter/src/EventEmitter.ts</h1> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<section> | ||
<article> | ||
<pre class="prettyprint source linenums"><code>import { findIndex, isObject } from "@daybrush/utils"; | ||
import { EventListener, EventHash, EventInfo, EventOptions, OnEvent, TargetParam } from "./types"; | ||
|
||
/** | ||
* Implement EventEmitter on object or component. | ||
*/ | ||
class EventEmitter<Events extends {} = { [key: string]: { [key: string]: any } }> { | ||
|
||
private _events: { | ||
[name: string]: EventInfo[], | ||
} = {}; | ||
public on<Name extends keyof Events, Param = Events[Name]>( | ||
eventName: Name, listener: EventListener<Param, this>): this; | ||
public on(events: EventHash<Events, this>): this; | ||
/** | ||
* Add a listener to the registered event. | ||
* @param - Name of the event to be added | ||
* @param - listener function of the event to be added | ||
* @example | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* cosnt emitter = new EventEmitter(); | ||
* | ||
* // Add listener in "a" event | ||
* emitter.on("a", () => { | ||
* }); | ||
* // Add listeners | ||
* emitter.on({ | ||
* a: () => {}, | ||
* b: () => {}, | ||
* }); | ||
*/ | ||
public on(eventName: string | object, listener?: EventListener<Events[any], this>): this { | ||
if (isObject(eventName)) { | ||
for (const name in eventName) { | ||
this.on<any>(name, eventName[name]); | ||
} | ||
} else { | ||
this._addEvent(eventName, listener, {}); | ||
} | ||
return this; | ||
} | ||
public off<Name extends keyof Events, Param = Events[Name]>( | ||
eventName?: Name, listener?: EventListener<Param, this>): this; | ||
public off(events: EventHash<Events, this>): this; | ||
/** | ||
* Remove listeners registered in the event target. | ||
* @param - Name of the event to be removed | ||
* @param - listener function of the event to be removed | ||
* @example | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* cosnt emitter = new EventEmitter(); | ||
* | ||
* // Remove all listeners. | ||
* emitter.off(); | ||
* | ||
* // Remove all listeners in "A" event. | ||
* emitter.off("a"); | ||
* | ||
* | ||
* // Remove "listener" listener in "a" event. | ||
* emitter.off("a", listener); | ||
*/ | ||
public off(eventName?: string | object, listener?: EventListener<Events[any], this>): this { | ||
if (!eventName) { | ||
this._events = {}; | ||
} else if(isObject(eventName)) { | ||
for (const name in eventName) { | ||
this.off<any>(name); | ||
} | ||
} else if (!listener) { | ||
this._events[eventName] = []; | ||
} else { | ||
const events = this._events[eventName]; | ||
|
||
if (events) { | ||
const index = findIndex(events, e => e.listener === listener); | ||
|
||
if (index > -1) { | ||
events.splice(index, 1); | ||
} | ||
} | ||
} | ||
return this; | ||
} | ||
/** | ||
* Add a disposable listener and Use promise to the registered event. | ||
* @param - Name of the event to be added | ||
* @param - disposable listener function of the event to be added | ||
* @example | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* cosnt emitter = new EventEmitter(); | ||
* | ||
* // Add a disposable listener in "a" event | ||
* emitter.once("a", () => { | ||
* }); | ||
* | ||
* // Use Promise | ||
* emitter.once("a").then(e => { | ||
* }); | ||
*/ | ||
public once<Name extends keyof Events & string, Param = Events[Name]>( | ||
eventName: Name, listener?: EventListener<Param, this>): Promise<OnEvent<Param, this>> { | ||
if (listener) { | ||
this._addEvent(eventName, listener, { once: true }); | ||
} | ||
return new Promise<OnEvent<Param, this>>(resolve => { | ||
this._addEvent(eventName, resolve, { once: true }); | ||
}); | ||
} | ||
public emit<Name extends keyof Events, Param = Events[Name]>( | ||
eventName: {} extends Param ? Name : never): boolean; | ||
public emit<Name extends keyof Events, Param = Events[Name]>( | ||
eventName: Name, param: TargetParam<Param>): boolean; | ||
/** | ||
* Fires an event to call listeners. | ||
* @param - Event name | ||
* @param - Event parameter | ||
* @return If false, stop the event. | ||
* @example | ||
* | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* | ||
* | ||
* const emitter = new EventEmitter(); | ||
* | ||
* emitter.on("a", e => { | ||
* }); | ||
* | ||
* | ||
* emitter.emit("a", { | ||
* a: 1, | ||
* }); | ||
*/ | ||
public emit(eventName: string, param: TargetParam<any> = {}): boolean { | ||
const events = this._events[eventName]; | ||
|
||
if (!eventName || !events) { | ||
return true; | ||
} | ||
let isStop = false; | ||
|
||
param.eventType = eventName; | ||
param.stop = () => { | ||
isStop = true; | ||
}; | ||
param.currentTarget = this; | ||
|
||
|
||
[...events].forEach(info => { | ||
info.listener(param); | ||
if (info.once) { | ||
this.off<any>(eventName, info.listener); | ||
} | ||
}); | ||
|
||
return !isStop; | ||
} | ||
public trigger<Name extends keyof Events, Param = Events[Name]>(eventName: {} extends TargetParam<Param> ? Name : never): boolean; | ||
public trigger<Name extends keyof Events, Param = Events[Name]>(eventName: Name, param: TargetParam<Param>): boolean; | ||
/** | ||
* Fires an event to call listeners. | ||
* @param - Event name | ||
* @param - Event parameter | ||
* @return If false, stop the event. | ||
* @example | ||
* | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* | ||
* | ||
* const emitter = new EventEmitter(); | ||
* | ||
* emitter.on("a", e => { | ||
* }); | ||
* | ||
* | ||
* emitter.emit("a", { | ||
* a: 1, | ||
* }); | ||
*//** | ||
* Fires an event to call listeners. | ||
* @param - Event name | ||
* @param - Event parameter | ||
* @return If false, stop the event. | ||
* @example | ||
* | ||
* import EventEmitter from "@scena/event-emitter"; | ||
* | ||
* | ||
* const emitter = new EventEmitter(); | ||
* | ||
* emitter.on("a", e => { | ||
* }); | ||
* | ||
* // emit | ||
* emitter.trigger("a", { | ||
* a: 1, | ||
* }); | ||
*/ | ||
public trigger<Name extends keyof Events>(eventName: Name, param: TargetParam<any>= {}): boolean { | ||
return this.emit<any>(eventName, param); | ||
} | ||
|
||
private _addEvent(eventName: string, listener: EventListener<Events[any], this>, options: Partial<EventOptions>) { | ||
const events = this._events; | ||
|
||
events[eventName] = events[eventName] || []; | ||
|
||
const listeners = events[eventName]; | ||
|
||
listeners.push({ listener, ...options }); | ||
} | ||
} | ||
|
||
export default EventEmitter; | ||
</code></pre> | ||
</article> | ||
</section> | ||
|
||
|
||
|
||
|
||
|
||
<style> | ||
|
||
|
||
nav li[file="node_modules/@scena/event-emitter/src/eventemitter"]:after { | ||
display: none; | ||
} | ||
nav li[file="node_modules/@scena/event-emitter/src/eventemitter"] h4, nav li[file="node_modules/@scena/event-emitter/src/eventemitter"] ul { | ||
display: block; | ||
} | ||
</style> | ||
|
||
</div> | ||
|
||
<br class="clear"> | ||
|
||
<footer> | ||
Documentation generated by <a href="https://github.com/daybrush/jsdoc">JSDoc 0.4.3</a> on Thu Apr 20 2023 04:02:26 GMT+0900 (대한민국 표준시) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. | ||
</footer> | ||
|
||
<script>prettyPrint();</script> | ||
<script src="scripts/linenumber.js"></script> | ||
<script src="scripts/utils.min.js"></script> | ||
<script src="scripts/search.js"></script> | ||
<script src="scripts/custom.js"></script> | ||
</body> | ||
</html> |
Oops, something went wrong.