ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add signatures for once.

Browse Source
This commit is contained in:
Simon Seyock
2021-06-23 18:47:14 +02:00
committed by Andreas Hocevar
parent 1870a64984
commit d914006d51
25 changed files with 364 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/ol/Observable.js
View File

@@ -40,6 +40,11 @@ class Observable extends EventTarget {
*/
this.on = this.onInternal;
/***
* @type {OnSignature<EventTypes, import("./events/Event.js").default>}
*/
this.once = this.onceInternal;
/**
* @private
* @type {number}
@@ -87,15 +92,13 @@ class Observable extends EventTarget {
}
/**
* Listen once for a certain type of event.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
* @param {string|Array<string>} type Type.
* @param {function(import("./events/Event").default): (void|boolean)} listener Listener.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Event key.
* @protected
*/
once(type, listener) {
// the jsdoc api annotation follows below the class declaration.
onceInternal(type, listener) {
let key;
if (Array.isArray(type)) {
const len = type.length;
@@ -113,7 +116,7 @@ class Observable extends EventTarget {
/**
* Unlisten for a certain type of event.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @param {function(import("./events/Event").default): (void|boolean)} listener The listener function.
* @api
*/
un(type, listener) {
@@ -134,7 +137,7 @@ class Observable extends EventTarget {
* Listen for a certain type of event.
* @function
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @param {function(import("./events/Event").default): (void|boolean)} listener The listener function.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
@@ -142,6 +145,18 @@ class Observable extends EventTarget {
*/
Observable.prototype.on;
/**
* Listen once for a certain type of event.
* @function
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(import("./events/Event").default): (void|boolean)} listener The listener function.
* @return {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
Observable.prototype.once;
/**
* Removes an event listener using the key returned by `on()` or `once()`.
* @param {import("./events.js").EventsKey|Array<import("./events.js").EventsKey>} key The key returned by `on()`