New typedef syntax for EventsKey

This commit is contained in:
Andreas Hocevar
2018-03-07 13:44:15 +01:00
parent 5ca31e094e
commit 258b6e1d56
2 changed files with 12 additions and 14 deletions

View File

@@ -229,20 +229,6 @@ ol.DrawGeometryFunctionType;
ol.EventsConditionType;
/**
* Key to use with {@link ol.Observable#unByKey}.
*
* @typedef {{bindTo: (Object|undefined),
* boundListener: (ol.EventsListenerFunctionType|undefined),
* callOnce: boolean,
* deleteIndex: (number|undefined),
* listener: ol.EventsListenerFunctionType,
* target: (EventTarget|ol.events.EventTarget),
* type: string}}
*/
ol.EventsKey;
/**
* Listener function. This function is called with an event object as argument.
* When the function returns `false`, event propagation will stop.

View File

@@ -9,3 +9,15 @@
* @api
*/
/**
* Key to use with {@link module:ol/Observable~Observable#unByKey}.
* @typedef {Object} EventsKey
* @property {Object} [bindTo]
* @property {ol.EventsListenerFunctionType} [boundListener]
* @property {boolean} callOnce
* @property {number} [deleteIndex]
* @property {ol.EventsListenerFunctionType} listener
* @property {EventTarget|ol.events.EventTarget} target
* @property {string} type
*/