fix: axiosConfig typo - #44
Open
bmortimer wants to merge 1 commit into
Open
Conversation
docs: add notes about API timeouts and large dataset performance
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
docs: add notes about API timeouts and large dataset performance
fix: typo in AxiosConfirg
Overview
What is the feature?
This PR improves inline documentation for the HockeyTech client by adding guidance around API performance limitations, including timeouts and large dataset requests. It also fixes a small typo in the AxiosRequestConfig parameter name.
Testing
What's required for testing?
No special setup required
Optional: TypeScript environment to verify typings
Other Notes
These changes are documentation-only and do not affect runtime behavior
Notes are based on observed API behavior (slow responses and timeouts with large queries)
Aimed at helping developers avoid common pitfalls when interacting with the HockeyTech API