Add ol.Observable.unByKey #2794
Merged
Conversation
This file contains hidden or 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
|
LGTM and +1 on deprecating |
| @@ -99,5 +109,5 @@ ol.Observable.prototype.un = function(type, listener, opt_this) { | |||
| * @api stable | |||
| */ | |||
| ol.Observable.prototype.unByKey = function(key) { | |||
There was a problem hiding this comment.
The function could be a simple alias:
ol.Observable.prototype.unByKey = ol.Observable.unByKey;There was a problem hiding this comment.
Actually the API docs does not look good if I use:
ol.Observable.prototype.unByKey = ol.Observable.unByKey;This is what it looks like:
The unByKey method is placed in a Members section, and it is not with the other methods.
So I decided not to use the alias.
There was a problem hiding this comment.
A @function jsdoc tag is probably needed in this case
There was a problem hiding this comment.
This indeed works! I keep forgetting about that annotation. I'm amending the commit. Thanks.
|
Looks good to me too. Hard to imagine 4.0 at this point, and it feels sloppy to have something deprecated immediately after 3.0. So I wouldn't be motivated to add anything to the docs (it would show up on almost every type), but that's a personal opinion. |
|
Agree with @tschaub. I'll add in the docs that using the static function rather than the method is encouraged. |
|
Thanks, please merge |
gberaudo
added a commit
to gberaudo/openlayers
that referenced
this pull request
Nov 19, 2014
The ol.Observable.prototype.unByKey was supposed to handle removing of listeners registered using `ol.Observable.prototype.on` and `ol.Observable.prototype.once`. However, the underlying google library code called by unByKey only requires the key, not the `ol.Observable` object on which the registration was triggered. Moreover, this method was unconvenient and in practice misused. Example or real world code: ```javascript var map = new ol.Map(); var key = map.on(listener); view.unByKey(key); ``` A function was added in openlayers#2794, in particular to fix this kind of code. This PR pushes forward the removal process of the old method in favor of the unByKey function by marking it `@deprecated` and pointing to the right usage. Please merge when deemed appropriate.
gberaudo
added a commit
to gberaudo/openlayers
that referenced
this pull request
Nov 19, 2014
The ol.Observable.prototype.unByKey was supposed to handle removing of listeners registered using `ol.Observable.prototype.on` and `ol.Observable.prototype.once`. However, the underlying google library code called by unByKey only requires the key, not the `ol.Observable` object on which the registration was triggered. Moreover, this method was unconvenient and in practice misused. Example or real world code: ```javascript var map = new ol.Map(); var key = map.on(listener); view.unByKey(key); ``` A function was added in openlayers#2794, in particular to fix this kind of code. This PR pushes forward the removal process of the old method in favor of the unByKey function by marking it `@deprecated` and pointing to the right usage. Please merge when deemed appropriate.
gberaudo
added a commit
to gberaudo/openlayers
that referenced
this pull request
Nov 19, 2014
The ol.Observable.prototype.unByKey was supposed to handle removing of listeners registered using `ol.Observable.prototype.on` and `ol.Observable.prototype.once`. However, the underlying google library code called by unByKey only requires the key, not the `ol.Observable` object on which the registration was triggered. Moreover, this method was unconvenient and in practice misused. Example or real world code: ```javascript var map = new ol.Map(); var key = map.on(listener); view.unByKey(key); ``` A function was added in openlayers#2794, in particular to fix this kind of code. This PR pushes forward the removal process of the old method in favor of the unByKey function by marking it `@deprecated` and pointing to the right usage. Please merge when deemed appropriate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today we have
ol.Observable.prototype.unByKey:So it is a method wrapping a static function. That means it could instead be static:
Having a static function (
ol.Observable.unByKey) would be more convenient. Because when it is the time to unregister your listeners you may not have a reference to the object you registered your listeners on. You may even have an array of listener ids for listeners on multiple observables.Please review.
We could also consider
@deprecate'ingol.Observable.prototype.unByKey.