Enumerate Node.js APIs on main Node.js docs page #20539
Conversation
We don't currently have one place where you can look at-a-glance at what Node.js APIs are supported in Workers. The compatibility matrix here is very cool, overly detailed for a quick reference on what is or isn't supported: https://workers-nodejs-compat-matrix.pages.dev/ The clearest thing we can do is to provide a simple list of all non-deprecated, non-experimental APIs from Node.js (pulled this straight from the Node.js docs, in the same alphabetical order) — and state clearly which are supported, which we have partial support for, and which are not supported. And then link to our own relevant docs page. There are a few here that are currently supported, but we haven't yet added a docs page for. We'll need to follow up on this, so that the sidebar includes all of the Node.js APIs we currently support in the Workers Runtime.
irvinebroque
requested review from
a team,
GregBrimble,
ToriLindsay,
jasnell and
mikenomitch
as code owners
|
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. |
|
Preview URL: https://60817aba.preview.developers.cloudflare.com Files with changes (up to 15)
|
Co-authored-by: Yagiz Nizipli <[email protected]>
|
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 SummaryEnhanced the Node.js documentation for Workers by providing a clear overview of supported APIs, including their status and links to relevant documentation.
Modified 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 What is Hyperlint?Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation. |
* Enumerate Node.js APIs on main Node.js docs page We don't currently have one place where you can look at-a-glance at what Node.js APIs are supported in Workers. The compatibility matrix here is very cool, overly detailed for a quick reference on what is or isn't supported: https://workers-nodejs-compat-matrix.pages.dev/ The clearest thing we can do is to provide a simple list of all non-deprecated, non-experimental APIs from Node.js (pulled this straight from the Node.js docs, in the same alphabetical order) — and state clearly which are supported, which we have partial support for, and which are not supported. And then link to our own relevant docs page. There are a few here that are currently supported, but we haven't yet added a docs page for. We'll need to follow up on this, so that the sidebar includes all of the Node.js APIs we currently support in the Workers Runtime. * Apply suggestions from code review Co-authored-by: Yagiz Nizipli <[email protected]> --------- Co-authored-by: Yagiz Nizipli <[email protected]>
6 participants
We don't currently have one place where you can look at-a-glance at what Node.js APIs are supported in Workers.
The compatibility matrix here is very cool, but too detailed for a quick reference on what is or isn't supported:
https://workers-nodejs-compat-matrix.pages.dev/
The clearest thing we can do is to provide a simple list of all non-deprecated, non-experimental APIs from Node.js (pulled this straight from the Node.js docs, in the same alphabetical order) — and state clearly which are supported, which we have partial support for, and which are not supported. And then link to our own relevant docs page.
There are a few here that are currently supported, but we haven't yet added a docs page for. We'll need to follow up on this, so that the sidebar includes all of the Node.js APIs we currently support in the Workers Runtime.