WIP - Adding changelog for node compat improvements #19341
Draft
+96
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TODO: * Add docs and proper links
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
| import { Render, PackageManagers, TypeScriptExample } from "~/components" | ||
|
|
||
| <!-- TODO: Add these docs --> | ||
| When using a worker with [nodejs_compatability](/workers/runtime-apis/nodejs/) enabled, you can now use the following Node.js APIs: |
There was a problem hiding this comment.
Suggested change
| When using a worker with [nodejs_compatability](/workers/runtime-apis/nodejs/) enabled, you can now use the following Node.js APIs: | |
| When using a Worker with [nodejs_compatability](/workers/runtime-apis/nodejs/) enabled, you can now use the following Node.js APIs: |
Issues:
- Style Guide - (Terms-error) Use 'Worker' instead of 'worker'.
Fix Explanation:
The term 'worker' should be capitalized to 'Worker' to adhere to the style guide, as it likely refers to a specific product or service name.
|
|
||
| You can use [`net.Socket`](https://nodejs.org/api/net.html#class-netsocket) to create a direct connection to a server via a TCP socket. | ||
| This can be useful when connecting to databases such as MySQL or PostgreSQL, though if possible, using | ||
| [Hyperdrive Connection Pooling](https://developers.cloudflare.com/hyperdrive/configuration/how-hyperdrive-works/#connection-pooling) is preferable. |
There was a problem hiding this comment.
Suggested change
| [Hyperdrive Connection Pooling](https://developers.cloudflare.com/hyperdrive/configuration/how-hyperdrive-works/#connection-pooling) is preferable. | |
| [Hyperdrive Connection Pooling](/hyperdrive/configuration/how-hyperdrive-works/#connection-pooling) is preferable. |
Issues:
- Style Guide - (cloudflare.LinkChecks-warning) Warning: When referring to another page in our docs, use the full relative link (
/1.1.1.1/check/) instead of the full URL (https://developers.cloudflare.com/1.1.1.1/check/) or a local development link (http://localhost:111/1.1.1.1/check/).
Fix Explanation:
The link was changed from a full URL to a relative link as per the style guide recommendation. This ensures that the documentation remains consistent and adaptable to changes in the base URL.
anonrig
reviewed
Jan 22, 2025
| ``` | ||
|
|
||
| Note that due to [security-based restrictions on timers](/workers/reference/security-model/#step-1-disallow-timers-and-multi-threading) in Workers, | ||
| timers are limited to returning the time of the last I/O. This means that while setTimeout and setInterval will defer your function execution |
There was a problem hiding this comment.
Suggested change
| timers are limited to returning the time of the last I/O. This means that while setTimeout and setInterval will defer your function execution | |
| timers are limited to returning the time of the last I/O. This means that while setTimeout, setInterval and setImmediate will defer your function execution |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
Summary
Screenshots (optional)
Documentation checklist