-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Add compat flag docs for FinalizationRegistry and WeakRef #20668
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
Add compat flag docs for FinalizationRegistry and WeakRef #20668
Conversation
Howdy and thanks for contributing to our repo. 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. |
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 SummaryAdded documentation for the compatibility flags related to
Added Files
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 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 |
aca3e3e
to
68ed6c7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have an example, and an example use case that we could share as part of this?
Def changelog worthy, esp if we help people connect the dots to what this makes possible w/WASM @mikenomitch
We can definitely mention that |
It improves memory management for workers-rs, right? That seems like a story right there? |
Will definitely improve memory management for all wasm users frankly, not just workers-rs :) |
Awesome - let's tell the story and explain! @mikenomitch |
68ed6c7
to
6c652c3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we going to write a changelog entry for this?
https://developers.cloudflare.com/changelog/
And show examples? Or explain what this means for workers-rs?
@danlapid @mikenomitch what do you think? We can certainly mention this in workers-rs or "Rust" section of workers docs. We can possibly have a changelog mentioning improvement in wasm interop/memory usage, but I don't think we want to explicitly advertise the FinalizationRegistry API. |
@irvinebroque @mikenomitch let me know if this looks good, the compat date is due soon so I'd want this to be available in docs before that |
src/content/changelog/workers/2025-04-24-finalization-registry.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved to unblock, but added a suggested change to changelog
Summary
Add docs for WeakRef compat flag.
Screenshots (optional)
Documentation checklist