1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-11 18:17:48 -05:00
denoland-deno/ext/node/polyfills
Trevor Manz 6b7e4c331b
fix(ext/node): add fs.promises.fstat and FileHandle#stat (#26719)
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-11-25 15:02:38 +09:00
..
_fs fix(ext/node): add fs.promises.fstat and FileHandle#stat (#26719) 2024-11-25 15:02:38 +09:00
_process fix(ext/node): allow writing to tty columns (#26201) 2024-10-14 14:00:02 +05:30
_util fix(runtime): use more null proto objects again (#25040) 2024-09-06 12:52:59 +02:00
assert chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dns chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs fix(ext/node): add fs.promises.fstat and FileHandle#stat (#26719) 2024-11-25 15:02:38 +09:00
inspector fix(ext/node): better inspector support (#26471) 2024-11-06 14:08:26 +00:00
internal fix(ext/node): add fs.promises.fstat and FileHandle#stat (#26719) 2024-11-25 15:02:38 +09:00
internal_binding fix(ext/node): add autoSelectFamily option to net.createConnection (#26661) 2024-11-12 19:54:47 +09:00
path fix(ext/node): Add missing node:path exports (#25567) 2024-09-11 00:00:08 +00:00
readline chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
stream feat(ext/node): export more symbols from streams and timers/promises (#25582) 2024-09-12 01:02:50 +02:00
timers feat(ext/node): export 'promises' symbol from 'node:timers' (#25589) 2024-09-12 20:30:49 +00:00
util chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
00_globals.js chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
01_require.js fix(node): regression where ts files were sometimes resolved instead of js (#26971) 2024-11-21 16:37:10 +00:00
02_init.js fix(ext/node): attach console stream properties (#25617) 2024-09-13 17:28:35 -07:00
_brotli.js fix(runtime): use more null proto objects again (#25040) 2024-09-06 12:52:59 +02:00
_events.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_events.mjs feat(ext/node): add abort helpers, process & streams fix (#25262) 2024-09-05 09:22:52 +02:00
_global.d.ts feat(ext/node): rewrite crypto keys (#24463) 2024-08-07 08:43:58 +02:00
_http_agent.mjs chore: update the copyright of c, mjs, and jsx (#25005) 2024-08-12 12:41:32 -04:00
_http_common.ts feat(ext/node): expose ES modules for _ modules (#25588) 2024-09-12 00:52:08 +00:00
_http_outgoing.ts feat(ext/node): expose ES modules for _ modules (#25588) 2024-09-12 00:52:08 +00:00
_http_server.ts feat(ext/node): expose ES modules for _ modules (#25588) 2024-09-12 00:52:08 +00:00
_next_tick.ts fix: report exceptions from nextTick (#26579) 2024-10-28 18:16:43 +01:00
_readline.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_readline.mjs chore: update the copyright of c, mjs, and jsx (#25005) 2024-08-12 12:41:32 -04:00
_readline_shared_types.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_stream.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_stream.mjs feat(ext/node): export more symbols from streams and timers/promises (#25582) 2024-09-12 01:02:50 +02:00
_tls_common.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_tls_wrap.ts fix(node:tls): set TLSSocket.alpnProtocol for client connections (#26476) 2024-10-23 07:47:43 +00:00
_utils.ts fix(ext/node): use ERR_NOT_IMPLEMENTED for notImplemented (#26853) 2024-11-13 19:47:01 +05:30
_zlib.mjs fix(node:zlib): gzip & gzipSync should accept ArrayBuffer (#26762) 2024-11-06 15:12:24 +01:00
_zlib_binding.mjs chore: update the copyright of c, mjs, and jsx (#25005) 2024-08-12 12:41:32 -04:00
assert.ts feat: vm rewrite (#24596) 2024-08-06 12:52:53 +00:00
assertion_error.ts feat: Deno.{stdin,stdout,stderr}.isTerminal(), deprecate Deno.isatty() (#22011) 2024-01-24 00:01:56 +01:00
async_hooks.ts feat(ext/node): export missing symbols from domain, puncode, repl, tls (#25585) 2024-09-12 02:25:46 +02:00
buffer.ts feat(ext/node): buffer.transcode() (#25972) 2024-10-02 08:23:14 +00:00
child_process.ts fix(child_process): map node --no-warnings flag to --quiet (#26288) 2024-10-16 18:25:25 +00:00
cluster.ts fix(node/cluster): improve stubs to make log4js work (#25146) 2024-08-26 11:19:58 +02:00
console.ts fix(ext/node): use primordials in ext/node/polyfills/console.ts (#25572) 2024-09-11 17:55:58 +10:00
constants.ts fix(ext/node): Add missing node:fs and node:constants exports (#25568) 2024-09-11 00:37:23 +00:00
crypto.ts fix(ext/node): add crypto.subtle (#23027) 2024-03-22 18:56:36 +05:30
dgram.ts fix(ext/node/net): emit error before close when connection is refused (#24656) 2024-07-24 20:33:45 +09:00
diagnostics_channel.js fix(ext/node): better support for node:diagnostics_channel module (#24088) 2024-06-15 00:07:02 +02:00
dns.ts fix(ext/node): Match punycode module behavior to node (#22847) 2024-03-11 15:49:43 -07:00
domain.ts feat(ext/node): export missing symbols from domain, puncode, repl, tls (#25585) 2024-09-12 02:25:46 +02:00
events.ts feat(ext/node): add abort helpers, process & streams fix (#25262) 2024-09-05 09:22:52 +02:00
fs.ts fix(ext/node): add fs.promises.fstat and FileHandle#stat (#26719) 2024-11-25 15:02:38 +09:00
http.ts fix(ext/node): return this from http.Server.ref/unref() (#26647) 2024-10-30 20:13:32 +00:00
http2.ts fix(ext/node): handle http2 server ending stream (#26235) 2024-10-15 23:35:10 +05:30
https.ts Revert "fix(ext/node): use primordials in ext/node/polyfills/https.ts (#26323)" (#26613) 2024-10-29 00:41:02 +00:00
inspector.js fix(ext/node): better inspector support (#26471) 2024-11-06 14:08:26 +00:00
net.ts fix(ext/node): add autoSelectFamily option to net.createConnection (#26661) 2024-11-12 19:54:47 +09:00
os.ts fix(node): Implement os.userInfo properly, add missing toPrimitive (#24702) 2024-10-31 22:18:33 -07:00
path.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
perf_hooks.ts feat(ext/node): perf_hooks.monitorEventLoopDelay() (#26905) 2024-11-19 16:49:25 +05:30
process.ts feat(node): stabilize detecting if CJS via "type": "commonjs" in a package.json (#26439) 2024-11-13 15:10:09 +00:00
punycode.ts feat(ext/node): export missing symbols from domain, puncode, repl, tls (#25585) 2024-09-12 02:25:46 +02:00
querystring.js fix(ext/node): querystring stringify without encode callback (#21740) 2024-01-02 04:54:11 +00:00
readline.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
README.md chore: move tools/node_compat to tests/node_compat/runner (#23025) 2024-04-03 09:24:55 +11:00
repl.ts feat(ext/node): export missing symbols from domain, puncode, repl, tls (#25585) 2024-09-12 02:25:46 +02:00
stream.ts feat(ext/node): export more symbols from streams and timers/promises (#25582) 2024-09-12 01:02:50 +02:00
string_decoder.ts fix(runtime): use more null proto objects again (#25040) 2024-09-06 12:52:59 +02:00
sys.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
testing.ts chore: enable no-console dlint rule (#25113) 2024-08-20 15:14:37 -04:00
timers.ts fix(ext/node): New async setInterval function to improve the nodejs compatibility (#26703) 2024-11-16 16:01:19 +01:00
tls.ts feat(ext/node): add rootCertificates to node:tls (#25707) 2024-09-18 21:14:26 +02:00
trace_events.ts fix(ext/node): add stubs for node:trace_events (#25628) 2024-09-15 08:15:09 +05:30
tty.js fix(node/tty): fix tty.WriteStream.hasColor with different args (#25094) 2024-08-19 17:13:09 +02:00
url.ts chore: sync up Node.js test files for v20.11.1 (#24066) 2024-06-11 11:41:44 +00:00
util.ts fix(node/util): export styleText from node:util (#26194) 2024-10-12 19:36:23 +00:00
v8.ts fix(ext/node): remove unimplemented promiseHook stubs (#25979) 2024-10-02 12:52:05 +05:30
vm.js chore: update dlint to v0.68.0 for internal (#26711) 2024-11-04 12:17:11 -05:00
wasi.ts fix(ext/node): use primordials in ext/node/polyfills/wasi.ts (#25608) 2024-09-13 22:31:07 +05:30
worker_threads.ts fix(node): fix worker_threads issues blocking Angular support (#26024) 2024-10-04 09:26:32 -07:00
zlib.ts fix(ext/node): zlib.crc32() (#26856) 2024-11-13 20:07:45 +05:30

Deno Node.js compatibility

This module is meant to have a compatibility layer for the Node.js standard library.

Warning: Any function of this module should not be referred anywhere in the Deno standard library as it's a compatibility module.

Supported modules

  • assert
  • assert/strict partly
  • async_hooks partly
  • buffer
  • child_process partly
  • cluster partly
  • console partly
  • constants partly
  • crypto partly
  • dgram partly
  • diagnostics_channel partly
  • dns partly
  • events
  • fs partly
  • fs/promises partly
  • http partly
  • http2
  • https partly
  • inspector partly
  • module
  • net
  • os partly
  • path
  • path/posix
  • path/win32
  • perf_hooks
  • process partly
  • punycode
  • querystring
  • readline
  • repl partly
  • stream
  • stream/promises
  • stream/web partly
  • string_decoder
  • sys
  • timers
  • timers/promises
  • tls
  • trace_events
  • tty partly
  • url
  • util partly
  • util/types partly
  • v8
  • vm partly
  • wasi
  • webcrypto
  • worker_threads
  • zlib
  • node globals partly

Deprecated

These modules are deprecated in Node.js and will probably not be polyfilled:

  • domain
  • freelist

Experimental

These modules are experimental in Node.js and will not be polyfilled until they are stable:

  • diagnostics_channel
  • async_hooks
  • policies
  • trace_events
  • wasi
  • webcrypto

CommonJS modules loading

createRequire(...) is provided to create a require function for loading CJS modules. It also sets supported globals.

import { createRequire } from "node:module";

const require = createRequire(import.meta.url);
// Loads native module polyfill.
const path = require("path");
// Loads extensionless module.
const cjsModule = require("./my_mod");
// Visits node_modules.
const leftPad = require("left-pad");

Contributing

Setting up the test runner and running tests

See tests/node_compat/runner/README.md.

Best practices

When converting from promise-based to callback-based APIs, the most obvious way is like this:

promise.then((value) => callback(null, value)).catch(callback);

This has a subtle bug - if the callback throws an error, the catch statement will also catch that error, and the callback will be called twice. The correct way to do it is like this:

promise.then((value) => callback(null, value), callback);

The second parameter of then can also be used to catch errors, but only errors from the existing promise, not the new one created by the callback.

If the Deno equivalent is actually synchronous, there's a similar problem with try/catch statements:

try {
  const value = process();
  callback(null, value);
} catch (err) {
  callback(err);
}

Since the callback is called within the try block, any errors from it will be caught and call the callback again.

The correct way to do it is like this:

let err, value;
try {
  value = process();
} catch (e) {
  err = e;
}
if (err) {
  callback(err); // Make sure arguments.length === 1
} else {
  callback(null, value);
}

It's not as clean, but prevents the callback being called twice.

Remaining Tests

Node compatibility can be measured by how many native Node tests pass. If you'd like to know what you can work on, check out the list of Node tests remaining here.