cloudflare-workers-node-compat

Cloudflare Workers Compat

This module is highly experimental, and incomplete.

The goal is to provide shim modules for every builtin Node module, so that you can use existing Node code in Cloudflare Workers.

It compiles Deno's node compatibility layer to modules that are Cloudflare Workers-compatible, or uses other browser-compatible modules.

It also includes shims for Deno, in case you want to use a Deno module in a Cloudflare Worker (e.g. @bubblydoo/cloudflare-workers-postgres-client).

Next to that eval and new Function are also replaced with warning functions.

npm i -D cloudflare-workers-compat

To use it, use esbuild:

// build.mjs

import alias from "esbuild-plugin-alias";
import bundlerConfig from "cloudflare-workers-compat/bundler-config";
import { outputReplacesPlugin, aliasPlugin } from "cloudflare-workers-compat/esbuild";

const compatConfig = await bundlerConfig({
  nodeBuiltinModules: true, // replaces node builtins like `assert`, `util`, ...
  nodeGlobals: true, // replaces Node globals like `global`
  workerIncompatibles: true // replaces `eval` and `new Function` with warning functions
});

await build({
  ...,
  metafile: true,
  define: compatConfig.define,
  inject: compatConfig.inject,
  plugins: [
    aliasPlugin(compatConfig.aliases),
    outputReplacesPlugin(compatConfig.replaces)
  ]
});

Shims are included for:

• assert (through assert)
• buffer (through buffer)
• console (through console-browserify)
• crypto (through crypto-browserify)
• events (through https://deno.land/std/node/events.ts)
• fs (empty object)
• os (through os-browserify/browser)
• path (through path-browserify)
• process (through https://deno.land/std/node/process.ts)
• querystring (through qs)
• stream (through stream-browserify)
• string_decoder (through https://deno.land/std/node/string_decoder.ts)
• timers (empty object)
• tty (through https://deno.land/std/node/tty.ts)
• url (through url-shim)
• util (through https://deno.land/std/node/util.ts)