Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention the safe range of 'time' param value of timeout() #36054

Merged

Conversation

BartoszKlonowski
Copy link
Contributor

This pull request fixes #36044

It adds the brief note of a range of value that can be passed to timeout() method.
Because the time should be of type unsigned long, I described it as the range of 0 Number.MAX_SAFE_INTEGER.

@BartoszKlonowski BartoszKlonowski requested a review from a team as a code owner September 25, 2024 22:59
@BartoszKlonowski BartoszKlonowski requested review from sideshowbarker and removed request for a team September 25, 2024 22:59
@github-actions github-actions bot added Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed labels Sep 25, 2024
Copy link
Contributor

github-actions bot commented Sep 25, 2024

Preview URLs

(comment last updated: 2024-09-26 22:12:40)

@github-actions github-actions bot added size/s [PR only] 6-50 LoC changed and removed size/xs [PR only] 0-5 LoC changed labels Sep 25, 2024
@@ -27,6 +27,7 @@ AbortSignal.timeout(time)

- `time`
- : The "active" time in milliseconds before the returned {{domxref("AbortSignal")}} will abort.
The value must be within range of 0 and {{jsxref("Number.MAX_SAFE_INTEGER")}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The value must be within range of 0 and {{jsxref("Number.MAX_SAFE_INTEGER")}}
The value must be within range of 0 and {{jsxref("Number.MAX_SAFE_INTEGER")}}.

@@ -69,3 +70,7 @@ try {
## Browser compatibility

{{Compat}}

## See also
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this; it's a really minor point and not directly related. If you really want to add a see also, link to setTimeout instead.

@github-actions github-actions bot added size/xs [PR only] 0-5 LoC changed and removed size/s [PR only] 6-50 LoC changed labels Sep 26, 2024
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@Josh-Cena Josh-Cena merged commit 9ffa9c1 into mdn:main Sep 26, 2024
8 checks passed
OnkarRuikar pushed a commit to OnkarRuikar/content that referenced this pull request Sep 28, 2024
* Mention the safe range of 'time' param value of timeout()

* Add 'isSafeInteger' to the See also section

* Correct the link for case sensitivity

* Revert "Correct the link for case sensitivity"

This reverts commit 8760abd.

* Revert "Add 'isSafeInteger' to the See also section"

This reverts commit 9d72aa5.

* Add missing dot for the range addition
fiji-flo pushed a commit that referenced this pull request Oct 2, 2024
* Mention the safe range of 'time' param value of timeout()

* Add 'isSafeInteger' to the See also section

* Correct the link for case sensitivity

* Revert "Correct the link for case sensitivity"

This reverts commit 8760abd.

* Revert "Add 'isSafeInteger' to the See also section"

This reverts commit 9d72aa5.

* Add missing dot for the range addition
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AbortController.timeout max value
2 participants