Update docs for nodejs_compat default enable date #17043
Merged
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
Simplifies docs to direct people to use `nodejs_compat` rather than `nodejs_compat_v2`. Tries to reiterate the need to set your compatibility date multiple times, since this is an important detail to follow that could otherwise be missed.
irvinebroque
requested review from
jasnell,
mikenomitch,
kodster28,
GregBrimble and
a team
as code owners
Deploying cloudflare-docs with
|
| Latest commit: |
5e1b979
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://61d85bad.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://bib-nodejs-compat-simpler.cloudflare-docs-7ou.pages.dev |
|
Files with changes (up to 15)
|
ToriLindsay
approved these changes
Sep 24, 2024
Co-authored-by: ToriLindsay <tgalatro@cloudflare.com>
petebacondarwin
approved these changes
Sep 24, 2024
mikenomitch
reviewed
Sep 24, 2024
| ``` | ||
|
|
||
| :::note | ||
| Starting on September 23rd, 2024, when your compatibility date is on or after `2024-09-23`, the `nodejs_compat` compatibility flag will enable the exact same behavior as `nodejs_compat_v2`. | ||
| As of September 23rd, 2024, the `nodejs_compat` compatibility flag enables the exact same behavior as the `nodejs_compat_v2` compatibility flag, as long as your compatibility date is set to September 23rd, 2024 or later. |
There was a problem hiding this comment.
Do you think we should explicitly say that you can move back the compatibility date before 9-23 to get the old behavior? Obviously not something we want to encourage broadly, but if somebody runs into a bug with V2 that's not on V1 then it could give them a workaround.
mikenomitch
reviewed
Sep 24, 2024
| compatibility_flags = [ "nodejs_compat_v2" ] | ||
| ``` | ||
|
|
||
| ## Enable Node.js in Pages Functions |
There was a problem hiding this comment.
This all still seems relevant. Why drop it?
There was a problem hiding this comment.
It works the same way as Workers? Set flag in wrangler.toml.
irvinebroque
commented
Sep 24, 2024
| compatibility_flags = [ "nodejs_compat_v2" ] | ||
| ``` | ||
|
|
||
| ## Enable Node.js in Pages Functions |
There was a problem hiding this comment.
It works the same way as Workers? Set flag in wrangler.toml.
patriciasantaana
pushed a commit
that referenced
this pull request
Sep 26, 2024
* Update docs for nodejs_compat default enable date Simplifies docs to direct people to use `nodejs_compat` rather than `nodejs_compat_v2`. Tries to reiterate the need to set your compatibility date multiple times, since this is an important detail to follow that could otherwise be missed. * Apply suggestions from code review Co-authored-by: ToriLindsay <tgalatro@cloudflare.com> * Update src/content/docs/workers/runtime-apis/nodejs/index.mdx --------- Co-authored-by: ToriLindsay <tgalatro@cloudflare.com>
elithrar
pushed a commit
that referenced
this pull request
Oct 15, 2024
* Update docs for nodejs_compat default enable date Simplifies docs to direct people to use `nodejs_compat` rather than `nodejs_compat_v2`. Tries to reiterate the need to set your compatibility date multiple times, since this is an important detail to follow that could otherwise be missed. * Apply suggestions from code review Co-authored-by: ToriLindsay <tgalatro@cloudflare.com> * Update src/content/docs/workers/runtime-apis/nodejs/index.mdx --------- Co-authored-by: ToriLindsay <tgalatro@cloudflare.com>
maheshwarip
pushed a commit
that referenced
this pull request
Dec 2, 2024
* Update docs for nodejs_compat default enable date Simplifies docs to direct people to use `nodejs_compat` rather than `nodejs_compat_v2`. Tries to reiterate the need to set your compatibility date multiple times, since this is an important detail to follow that could otherwise be missed. * Apply suggestions from code review Co-authored-by: ToriLindsay <tgalatro@cloudflare.com> * Update src/content/docs/workers/runtime-apis/nodejs/index.mdx --------- Co-authored-by: ToriLindsay <tgalatro@cloudflare.com>
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.
Simplifies docs to direct people to use
nodejs_compatrather thannodejs_compat_v2. Tries to reiterate the need to set your compatibility date multiple times, since this is an important detail to follow that could otherwise be missed.