diff --git a/src/content/docs/workers/configuration/compatibility-flags.mdx b/src/content/docs/workers/configuration/compatibility-flags.mdx index df1c1de34622207..10a4bb927fc8277 100644 --- a/src/content/docs/workers/configuration/compatibility-flags.mdx +++ b/src/content/docs/workers/configuration/compatibility-flags.mdx @@ -45,17 +45,11 @@ Compatibility flags can be set when uploading a Worker using the [Workers Script ## Node.js compatibility flag -:::note -You can opt into improved Node.js compatibility by using `nodejs_compat_v2` instead of `nodejs_compat`. This provides the functionality of `nodejs_compat`, but -additionally you can import Node.js modules without the `node:` prefix and use polyfilled Node.js modules and globals that are not available with `nodejs_compat`. - -On September 23, 2024, `nodejs_compat` will use the improved Node.js compatibility currently enabled with `nodejs_compat_v2`. This will require updating your -compatibility_date to 2024-09-23 or later. -::: - -A [growing subset](/workers/runtime-apis/nodejs/) of Node.js APIs are available directly as [Runtime APIs](/workers/runtime-apis/nodejs), with no need to add polyfills to your own code. To enable these APIs in your Worker, add the `nodejs_compat` compatibility flag to your `wrangler.toml`: +import { Render } from "~/components"; + +A [growing subset](/workers/runtime-apis/nodejs/) of Node.js APIs are available directly as [Runtime APIs](/workers/runtime-apis/nodejs), with no need to add polyfills to your own code. To enable these APIs in your Worker, only the `nodejs_compat` compatibility flag is required: @@ -69,8 +63,6 @@ As additional Node.js APIs are added, they will be made available under the `nod The Node.js `AsyncLocalStorage` API is a particularly useful feature for Workers. To enable only the `AsyncLocalStorage` API, use the `nodejs_als` compatibility flag. - - ```toml title="wrangler.toml" diff --git a/src/content/docs/workers/runtime-apis/nodejs/index.mdx b/src/content/docs/workers/runtime-apis/nodejs/index.mdx index 4918c7dd8e1191d..fcfa2b566a089a1 100644 --- a/src/content/docs/workers/runtime-apis/nodejs/index.mdx +++ b/src/content/docs/workers/runtime-apis/nodejs/index.mdx @@ -18,22 +18,9 @@ You can view which APIs are supported using the [Node.js compatability matrix](h ## Get Started -To enable both built-in runtime APIs and polyfills for your Worker or Pages project, add the [`nodejs_compat`](/workers/configuration/compatibility-flags/#nodejs-compatibility-flag) [compatibility flag](/workers/configuration/compatibility-flags/#nodejs-compatibility-flag) to your `wrangler.toml`, and set your compatibility date to September 23rd, 2024 or later. +import { Render } from "~/components"; -import { WranglerConfig } from "~/components"; - - - -```toml title="wrangler.toml" -compatibility_flags = [ "nodejs_compat" ] -compatibility_date = "2024-09-23" -``` - - - -:::note -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. -::: + ## Built-in Node.js Runtime APIs @@ -68,7 +55,7 @@ If an API you wish to use is missing and you want to suggest that Workers suppor To enable only the Node.js `AsyncLocalStorage` API, use the `nodejs_als` compatibility flag. - +import { WranglerConfig } from "~/components"; diff --git a/src/content/partials/workers/nodejs_compat.mdx b/src/content/partials/workers/nodejs_compat.mdx new file mode 100644 index 000000000000000..31801eec778bfa9 --- /dev/null +++ b/src/content/partials/workers/nodejs_compat.mdx @@ -0,0 +1,20 @@ +--- +{} +--- + +import { WranglerConfig } from "~/components"; + +To enable both built-in runtime APIs and polyfills for your Worker or Pages project, add the [`nodejs_compat`](/workers/configuration/compatibility-flags/#nodejs-compatibility-flag) [compatibility flag](/workers/configuration/compatibility-flags/#nodejs-compatibility-flag) to your `wrangler.toml`, and set your compatibility date to September 23rd, 2024 or later. This will enable [Node.js compatibility](/workers/runtime-apis/nodejs/) for your Workers project. + + + +```toml title="wrangler.toml" +compatibility_flags = [ "nodejs_compat" ] +compatibility_date = "2024-09-23" +``` + + + +:::note +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. +:::