Skip to content

Conversation

@jasnell
Copy link
Contributor

@jasnell jasnell commented Jul 17, 2025

Summary

Start making some incremental improvements to the Workers nodejs_compat docs.

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 Jul 17, 2025

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

Made incremental improvements to the Workers Node.js compatibility documentation, enhancing clarity and detail.

  • Updated documentation to include links to relevant Node.js API references.
  • Clarified the behavior of the EventEmitter and Buffer APIs in the Workers runtime.
  • Added information about unsupported features in the crypto module.

Modified Files

  • src/content/docs/workers/runtime-apis/nodejs/EventEmitter.mdx
  • src/content/docs/workers/runtime-apis/nodejs/assert.mdx
  • src/content/docs/workers/runtime-apis/nodejs/buffer.mdx
  • src/content/docs/workers/runtime-apis/nodejs/crypto.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.


Further, in Node.js it is possible to allocate a `Buffer` with uninitialized memory
using the `Buffer.allocUnsafe()` method. This is not supported in Workers and `Buffer`
instances are always zero-filled when allocated.
Copy link
Contributor

Choose a reason for hiding this comment

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

Layman's description of zero-filled would probably help

@jasnell jasnell enabled auto-merge (squash) August 11, 2025 14:44
@jasnell jasnell merged commit ce39095 into cloudflare:production Aug 11, 2025
2 checks passed
thomasgauvin pushed a commit that referenced this pull request Aug 15, 2025
…3773)

* Start to making some incremental improvements to node compat docs

* Update src/content/docs/workers/runtime-apis/nodejs/EventEmitter.mdx

* Update src/content/docs/workers/runtime-apis/nodejs/buffer.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants