docs(ng-icons): update responseType in custom SVG loader example #90
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
Provide correct responseType option in the documentation for loading custom SVG icons using provideNgIconLoader. This change specifies the responseType as 'text' to ensure the HttpClient.get method returns an Observable<string> that can be used by the icon loader function. This correction addresses an issue where the documentation example did not match the expected function signature, potentially causing type mismatch errors for developers implementing the custom SVG loader.
ashley-hunter
approved these changes
Feb 13, 2024
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.
This pull request updates the documentation for the
provideNgIconLoaderusage example. The current documentation does not specify theresponseTypein the HTTP request, which leads to a type mismatch error as theHttpClient.getmethod defaults to returning anObservable<Object>.Changes made:
{ responseType: 'text' }as the second argument to thehttp.getmethod to ensure the response is treated as a plain text string.This modification ensures that when fetching custom SVG icons, the response is handled as an
Observable<string>, which aligns with the expected return type for theprovideNgIconLoaderfunction. The update should prevent type mismatch errors and clarify the correct usage for future developers.By correcting this example, developers will have a smoother experience when implementing custom SVG icon loaders using the
ng-iconslibrary.