@@ -13,8 +13,8 @@ Cloudflare Workers provides a subset of Node.js APIs in two forms:
1313
14141 . As built-in APIs provided by the Workers Runtime. Most of these APIs are
1515 full implementations of the corresponding Node.js APIs, while a few are
16- partially supported or non-functional stubs intended for the APIs to be
17- available for import only but not for actual use.
16+ partially supported or non-functional stubs intended for the APIs to be
17+ available for import only but not for actual use.
18182 . As polyfill shim implementations that [ Wrangler] ( /workers/wrangler/ ) adds to your Worker's code, allowing it to import the module, but calling API methods will throw errors.
1919
2020## Get Started
@@ -36,51 +36,51 @@ The runtime APIs from Node.js listed below as "🟢 supported" are currently nat
3636
3737[ Deprecated or experimental APIs from Node.js] ( https://nodejs.org/docs/latest/api/documentation.html#stability-index ) , and APIs that do not fit in a serverless context, are not included as part of the list below:
3838
39- | API Name | Natively supported by the Workers Runtime |
40- | --------------------------------------------------------------------------------------| -------------------------------------------|
41- | [ Assertion testing] ( /workers/runtime-apis/nodejs/assert/ ) | 🟢 supported |
42- | [ Asynchronous context tracking] ( /workers/runtime-apis/nodejs/asynclocalstorage/ ) | 🟢 supported |
43- | [ Async hooks] ( https://nodejs.org/docs/latest/api/async_hooks.html ) | 🟡 partially supported (non-functional) |
44- | [ Buffer] ( /workers/runtime-apis/nodejs/buffer/ ) | 🟢 supported |
45- | [ Child processes] ( https://nodejs.org/docs/latest/api/child_process.html ) | 🟡 partially supported (non-functional) |
46- | [ Cluster] ( https://nodejs.org/docs/latest/api/cluster.html ) | 🟡 partially supported (non-functional) |
47- | [ Console] ( https://nodejs.org/docs/latest/api/console.html ) | 🟡 partially supported |
48- | [ Crypto] ( /workers/runtime-apis/nodejs/crypto/ ) | 🟢 supported |
49- | [ Debugger] ( /workers/observability/dev-tools/ ) | 🟢 supported via [ Chrome Dev Tools integration] ( /workers/observability/dev-tools/ ) |
50- | [ Diagnostics Channel] ( /workers/runtime-apis/nodejs/diagnostics-channel/ ) | 🟢 supported |
51- | [ DNS] ( /workers/runtime-apis/nodejs/dns/ ) | 🟢 supported |
52- | Errors | 🟢 supported |
53- | [ Events] ( /workers/runtime-apis/nodejs/EventEmitter/ ) | 🟢 supported |
54- | [ File system] ( /workers/runtime-apis/nodejs/fs/ ) | 🟢 supported |
55- | Globals | 🟢 supported |
56- | [ HTTP] ( /workers/runtime-apis/nodejs/http/ ) | 🟢 supported |
57- | [ HTTP/2] ( https://nodejs.org/docs/latest/api/http2.html ) | 🟡 partially supported (non-functional) |
58- | [ HTTPS] ( /workers/runtime-apis/nodejs/https/ ) | 🟢 supported |
59- | [ Inspector] ( https://nodejs.org/docs/latest/api/inspector.html ) | 🟡 partially supported via [ Chrome Dev Tools integration] ( /workers/observability/dev-tools/ ) |
60- | [ Module] ( https://nodejs.org/docs/latest/api/module.html ) | 🟡 partially supported |
61- | [ Net] ( /workers/runtime-apis/nodejs/net/ ) | 🟢 supported |
62- | [ OS] ( https://nodejs.org/docs/latest/api/os.html ) | 🟡 partially supported |
63- | [ Path] ( /workers/runtime-apis/nodejs/path/ ) | 🟢 supported |
64- | [ Performance hooks] ( https://nodejs.org/docs/latest/api/perf_hooks.html ) | 🟡 partially supported |
65- | [ Process] ( /workers/runtime-apis/nodejs/process/ ) | 🟢 supported |
66- | [ Punycode] ( https://nodejs.org/docs/latest/api/punycode.html ) (deprecated) | 🟢 supported |
67- | [ Readline] ( https://nodejs.org/docs/latest/api/readline.html ) | 🟡 partially supported (non-functional) |
68- | [ REPL] ( https://nodejs.org/docs/latest/api/repl.html ) | 🟡 partially supported (non-functional) |
69- | [ Query strings] ( https://nodejs.org/docs/latest/api/querystring.html ) | 🟢 supported |
70- | [ SQLite] ( https://nodejs.org/docs/latest/api/sqlite.html ) | ⚪ not yet supported |
71- | [ Stream] ( /workers/runtime-apis/nodejs/streams ) | 🟢 supported |
72- | [ String decoder] ( /workers/runtime-apis/nodejs/string-decoder/ ) | 🟢 supported |
73- | [ Test runner] ( https://nodejs.org/docs/latest/api/test.html ) | ⚪ not supported |
74- | [ Timers] ( /workers/runtime-apis/nodejs/timers/ ) | 🟢 supported |
75- | [ TLS/SSL] ( /workers/runtime-apis/nodejs/tls/ ) | 🟡 partially supported |
76- | [ UDP/datagram] ( https://nodejs.org/docs/latest/api/dgram.html ) | 🟡 partially supported (non-functional) |
77- | [ URL] ( /workers/runtime-apis/nodejs/url/ ) | 🟢 supported |
78- | [ Utilities] ( /workers/runtime-apis/nodejs/util/ ) | 🟢 supported |
79- | [ V8] ( https://nodejs.org/docs/latest/api/v8.html ) | 🟡 partially supported (non-functional) |
80- | [ VM] ( https://nodejs.org/docs/latest/api/vm.html ) | 🟡 partially supported (non-functional) |
81- | [ Web Crypto API] ( /workers/runtime-apis/web-crypto/ ) | 🟢 supported |
82- | [ Web Streams API] ( /workers/runtime-apis/streams/ ) | 🟢 supported |
83- | [ Zlib] ( /workers/runtime-apis/nodejs/zlib/ ) | 🟢 supported |
39+ | API Name | Natively supported by the Workers Runtime |
40+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
41+ | [ Assertion testing] ( /workers/runtime-apis/nodejs/assert/ ) | 🟢 supported |
42+ | [ Asynchronous context tracking] ( /workers/runtime-apis/nodejs/asynclocalstorage/ ) | 🟢 supported |
43+ | [ Async hooks] ( https://nodejs.org/docs/latest/api/async_hooks.html ) | 🟡 partially supported (non-functional) |
44+ | [ Buffer] ( /workers/runtime-apis/nodejs/buffer/ ) | 🟢 supported |
45+ | [ Child processes] ( https://nodejs.org/docs/latest/api/child_process.html ) | 🟡 partially supported (non-functional) |
46+ | [ Cluster] ( https://nodejs.org/docs/latest/api/cluster.html ) | 🟡 partially supported (non-functional) |
47+ | [ Console] ( https://nodejs.org/docs/latest/api/console.html ) | 🟡 partially supported |
48+ | [ Crypto] ( /workers/runtime-apis/nodejs/crypto/ ) | 🟢 supported |
49+ | [ Debugger] ( /workers/observability/dev-tools/ ) | 🟢 supported via [ Chrome Dev Tools integration] ( /workers/observability/dev-tools/ ) |
50+ | [ Diagnostics Channel] ( /workers/runtime-apis/nodejs/diagnostics-channel/ ) | 🟢 supported |
51+ | [ DNS] ( /workers/runtime-apis/nodejs/dns/ ) | 🟢 supported |
52+ | Errors | 🟢 supported |
53+ | [ Events] ( /workers/runtime-apis/nodejs/EventEmitter/ ) | 🟢 supported |
54+ | [ File system] ( /workers/runtime-apis/nodejs/fs/ ) | 🟢 supported |
55+ | Globals | 🟢 supported |
56+ | [ HTTP] ( /workers/runtime-apis/nodejs/http/ ) | 🟢 supported |
57+ | [ HTTP/2] ( https://nodejs.org/docs/latest/api/http2.html ) | 🟡 partially supported (non-functional) |
58+ | [ HTTPS] ( /workers/runtime-apis/nodejs/https/ ) | 🟢 supported |
59+ | [ Inspector] ( https://nodejs.org/docs/latest/api/inspector.html ) | 🟡 partially supported via [ Chrome Dev Tools integration] ( /workers/observability/dev-tools/ ) |
60+ | [ Module] ( https://nodejs.org/docs/latest/api/module.html ) | 🟡 partially supported |
61+ | [ Net] ( /workers/runtime-apis/nodejs/net/ ) | 🟢 supported |
62+ | [ OS] ( https://nodejs.org/docs/latest/api/os.html ) | 🟡 partially supported |
63+ | [ Path] ( /workers/runtime-apis/nodejs/path/ ) | 🟢 supported |
64+ | [ Performance hooks] ( https://nodejs.org/docs/latest/api/perf_hooks.html ) | 🟡 partially supported |
65+ | [ Process] ( /workers/runtime-apis/nodejs/process/ ) | 🟢 supported |
66+ | [ Punycode] ( https://nodejs.org/docs/latest/api/punycode.html ) (deprecated) | 🟢 supported |
67+ | [ Readline] ( https://nodejs.org/docs/latest/api/readline.html ) | 🟡 partially supported (non-functional) |
68+ | [ REPL] ( https://nodejs.org/docs/latest/api/repl.html ) | 🟡 partially supported (non-functional) |
69+ | [ Query strings] ( https://nodejs.org/docs/latest/api/querystring.html ) | 🟢 supported |
70+ | [ SQLite] ( https://nodejs.org/docs/latest/api/sqlite.html ) | ⚪ not yet supported |
71+ | [ Stream] ( /workers/runtime-apis/nodejs/streams ) | 🟢 supported |
72+ | [ String decoder] ( /workers/runtime-apis/nodejs/string-decoder/ ) | 🟢 supported |
73+ | [ Test runner] ( https://nodejs.org/docs/latest/api/test.html ) | ⚪ not supported |
74+ | [ Timers] ( /workers/runtime-apis/nodejs/timers/ ) | 🟢 supported |
75+ | [ TLS/SSL] ( /workers/runtime-apis/nodejs/tls/ ) | 🟡 partially supported |
76+ | [ UDP/datagram] ( https://nodejs.org/docs/latest/api/dgram.html ) | 🟡 partially supported (non-functional) |
77+ | [ URL] ( /workers/runtime-apis/nodejs/url/ ) | 🟢 supported |
78+ | [ Utilities] ( /workers/runtime-apis/nodejs/util/ ) | 🟢 supported |
79+ | [ V8] ( https://nodejs.org/docs/latest/api/v8.html ) | 🟡 partially supported (non-functional) |
80+ | [ VM] ( https://nodejs.org/docs/latest/api/vm.html ) | 🟡 partially supported (non-functional) |
81+ | [ Web Crypto API] ( /workers/runtime-apis/web-crypto/ ) | 🟢 supported |
82+ | [ Web Streams API] ( /workers/runtime-apis/streams/ ) | 🟢 supported |
83+ | [ Zlib] ( /workers/runtime-apis/nodejs/zlib/ ) | 🟢 supported |
8484
8585Unless otherwise specified, native implementations of Node.js APIs in Workers are intended to match the implementation in the [ Current release of Node.js] ( https://github.com/nodejs/release#release-schedule ) .
8686
0 commit comments