Skip to content

Document Request.signal #20843

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
May 27, 2025
Merged

Document Request.signal #20843

merged 5 commits into from
May 27, 2025

Conversation

@npaun
Copy link
Member

@npaun npaun commented Mar 14, 2025

Summary

This PR updates the documentation of Request and adds a changelog entry to reflect the work done in cloudflare/workerd#3488

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 14, 2025 •
edited
Loading

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Updated the documentation for the Request interface to include the new signal property and its usage.

Modified Files

  • src/content/docs/workers/runtime-apis/request.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

npaun
npaun commented Mar 14, 2025
View reviewed changes
irvinebroque
irvinebroque reviewed Mar 14, 2025
View reviewed changes
@npaun npaun force-pushed the npaun/docs-request-signal branch from 4cf2e88 to fc52dbf Compare March 14, 2025 20:10
@github-actions github-actions bot added the product:workers Related to Workers product label Mar 14, 2025
@npaun npaun requested review from a team and WalshyDev as code owners March 14, 2025 21:43
@npaun npaun requested a review from irvinebroque March 14, 2025 21:44
@npaun npaun force-pushed the npaun/docs-request-signal branch from 6824c2b to ec9f8ce Compare May 22, 2025 16:47
@npaun npaun requested review from a team as code owners May 22, 2025 16:47
@npaun
Copy link
Member Author

npaun commented May 22, 2025

@irvinebroque, @mikenomitch
The feature is finally live in prod, but it's now behind a compat flag. I've updated the docs correspondingly. Could you please re-review this PR?

mikenomitch
mikenomitch approved these changes May 27, 2025
View reviewed changes
Copy link
Contributor

@mikenomitch mikenomitch left a comment

Choose a reason for hiding this comment

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

LGTM! - Added a few tiny nitpicks, but that's it. Nice work explaining and w the example

@npaun
Copy link
Member Author

npaun commented May 27, 2025

@mikenomitch Doesn't look like I have the ability to merge this myself.

@mikenomitch mikenomitch merged commit 3ca5da9 into cloudflare:production May 27, 2025
5 checks passed
@mikenomitch
Copy link
Contributor

mikenomitch commented May 27, 2025

@npaun done!

sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
@npaun @irvinebroque @sdnts
Document Request.signal (cloudflare#20843)
8563e96 
* Document Request.signal

* Apply improved wording from @irvinebroque

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* Improve example and include it in the documentation of Request

* Update docs to indicate a compat flag is required

* Wording improvements suggested by @mikenomitch

---------

Co-authored-by: Brendan Irvine-Broque <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kodster28 kodster28 kodster28 left review comments

@mikenomitch mikenomitch mikenomitch approved these changes

@ToriLindsay ToriLindsay ToriLindsay approved these changes

@jasnell jasnell Awaiting requested review from jasnell

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev is a code owner

@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner

Assignees

@jasnell jasnell

@pedrosousa pedrosousa

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@dcpena dcpena

@haleycode haleycode

@patriciasantaana patriciasantaana

@ToriLindsay ToriLindsay

Labels

product:workers Related to Workers product size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.