types(ajax): improve Ajax types and docs#6233
Merged
benlesh merged 2 commits intoReactiveX:masterfrom Apr 19, 2021
Merged
Conversation
| * The total number of bytes loaded so far. To be used with {@link total} while | ||
| * calcating progress. (You will want to set {@link includeDownloadProgress} or {@link includeDownloadProgress}) | ||
| * | ||
| * {@see {@link AjaxConfig}} |
Member
Author
There was a problem hiding this comment.
This @see doesn't work here (it doesn't seem to be rendered anywhere on the page). For this reason, I moved it to line 16.
| * response is available. | ||
| */ | ||
| public readonly type = 'download_load' | ||
| public readonly type: string = 'download_load' |
Member
Author
There was a problem hiding this comment.
This is a "fix" for the table at /api/ajax/AjaxResponse#properties where type property has had 'download_load' TypeScript type instead of string type.
benlesh
approved these changes
Apr 19, 2021
benlesh
approved these changes
Apr 19, 2021
Member
benlesh
left a comment
There was a problem hiding this comment.
Thank you for the thorough follow-up. It is appreciated!
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
2 participants
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 improves
ajaxdocs, introducesAjaxDirectiontype and fixes multiple typos.Also, some
npm run docsfailures are fixed with this PR, like:No handler provided for inline tag "{@see {@link AjaxConfig}"orError in {@link AjaxProgressEvents} - Invalid link (does not match any doc).Related issue (if exists):
None