open-feature / open-feature/js-sdk
List of breaking 2.0 changes
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 282
- Forks
- 72
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 16
Description
Please use this issue to compile a list of small breaking changes for 2.0. These should not require much to absorb should generally be small typing/naming changes.
List so far:
-
https://github.com/open-feature/js-sdk/pull/794 - make it impossible to return an error resolution from providers (force them to throw if something goes wrong)
- removing setProviderAndWait and make setProvider async
- consider renaming
Clientinterface to something less likely to clash (I'm not sure about this one, but @luizgribeiro wanted to consider it) -
CommonEventDetailsprops should all bereadonly - Remove references to named client. It has been deprecated in favor of domains for a while now.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the checklist in this issue and the referenced PR #794, then inspect the public APIs named here: provider error resolution, setProviderAndWait/setProvider, Client, CommonEventDetails, and named clients. Confirm the 2.0 decisions with maintainers and update each checklist item only when its corresponding breaking change is implemented and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100