Store segment flag on CO2 instance, not models #158
Merged
Conversation
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
No user impact is expected from this change. Background: you can ask `CO2` to return segmented results by setting the `results` option to `"segment"`. The `CO2` instance stores this flag for later. This changes where that flag is stored. Previously, it was stored as a public property of each model. This was unused by the model and is an unnecessary mutation. Now, the property is stored on the `CO2` instance. I believe this is easier to follow. It should also make it possible to turn the models from stateful classes into stateless objects, simplifying the code (an idea that was discussed [years ago][0]). This new flag is explicitly marked private with the [`@private` JSDoc tag][0] and implicitly marked private by prefixing its name with an underscore; a common JS convention. (I considered using [private class fields][1] instead, but browser support is new enough that this seemed risky.) [0]: thegreenwebfoundation#12 (comment) [1]: https://jsdoc.app/tags-private.html [2]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_class_fields
|
This change will be released with the next update for data, early August 2023. |
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.
No user impact is expected from this change.
Background: you can ask
CO2to return segmented results by setting theresultsoption to"segment". TheCO2instance stores this flag for later.This changes where that flag is stored. Previously, it was stored as a public property of each model. This was unused by the model and is an unnecessary mutation.
Now, the property is stored on the
CO2instance. I believe this is easier to follow. It should also make it possible to turn the models from stateful classes into stateless objects, simplifying the code (an idea that was discussed years ago).This new flag is explicitly marked private with the
@privateJSDoc tag and implicitly marked private by prefixing its name with an underscore; a common JS convention. (I considered using private class fields instead, but browser support is new enough that this seemed risky.)