feat: use makeEnvironmentProviders for type-safe provideAuth0 #785
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.
Description
This PR refactors the
provideAuth0function to returnEnvironmentProvidersinstead ofProvider[], enforcing type safety at compile-time and preventing incorrect usage in component providers.Fixes #664
Changes
provideAuth0()to usemakeEnvironmentProviders()and returnEnvironmentProvidersProvider[]toEnvironmentProvidersEXAMPLES.mdto reflect that this restriction is now enforced at compile-timeMotivation
Previously, developers could mistakenly add
provideAuth0()to a component'sprovidersarray, which could lead to unexpected behavior and runtime issues. While the documentation warned against this, there was no compile-timeenforcement.
By using
makeEnvironmentProviders, TypeScript now prevents this misuse:Before (incorrect usage would compile):
After (incorrect usage produces a type error):
Benefits
Testing
Related
provideAuth0function to return anEnvironmentProvidersinstead ofProvider[]#664 by @LcsGa