fix: provider js-doc improvments #506
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
|
@lukas-reining @thomaspoignant @beeme1mr if you agree, when this is merged, I will manually update the resulting web-sdk release PR to be |
beeme1mr
approved these changes
Jul 26, 2023
Signed-off-by: Todd Baert <[email protected]>
toddbaert
force-pushed
the
fix/add-stateful-provider
branch
from
9e2791d to
458061a
Compare
toddbaert
changed the title
toddbaert
pushed a commit
that referenced
this pull request
Jul 26, 2023
🤖 I have created a release *beep* *boop* --- ## [0.0.9](shared-v0.0.8...shared-v0.0.9) (2023-07-26) ### Bug Fixes * provider js-doc improvments ([#506](#506)) ([c815bc8](c815bc8)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
toddbaert
pushed a commit
that referenced
this pull request
Jul 26, 2023
🤖 I have created a release *beep* *boop* --- ## [0.0.9](shared-v0.0.8...shared-v0.0.9) (2023-07-26) ### Bug Fixes * provider js-doc improvments ([#506](#506)) ([c815bc8](c815bc8)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This was referenced Jul 26, 2023
toddbaert
added a commit
that referenced
this pull request
Jul 26, 2023
🤖 I have created a release *beep* *boop* --- ## [1.4.1](js-sdk-v1.4.0...js-sdk-v1.4.1) (2023-07-26) ### Bug Fixes * provider js-doc improvments ([#506](#506)) ([c815bc8](c815bc8)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Signed-off-by: Todd Baert <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Todd Baert <[email protected]>
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.
In 3 event provider implementations, flagd-java, go-feature-flag-web, and even my own implementation of flagd-js, authors have forgotten to properly implement
getState(which means the SDK assumes the provider is alreadyREADYand doesn't runinitialize().)This is an easy pitfall. To help with this, I'm adding doc.
We may be able to improve the interfaces to help with this, but I think this is a safe and helpful change for now.
Relates to: open-feature/java-sdk#531