1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-28 16:20:57 -05:00
denoland-deno/ext/node/polyfills
David Sherret bc782cee98
fix(node): resolve types via package.json for directory import (#22878)
Does a package resolve when resolving types for a directory (copying the
behaviour that typescript does).
2024-03-13 22:37:56 -04:00
..
_fs feat(node): implement fs.statfs() (#22862) 2024-03-13 10:57:59 +00:00
_process fix: update node process version to latest node LTS (#22709) 2024-03-05 17:02:08 +01:00
_util fix(node): util.callbackify (#22200) 2024-02-01 08:51:10 +05:30
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(node): add cp to fs/promises (#22263) 2024-02-06 12:32:58 +05:30
internal feat(node): implement fs.statfs() (#22862) 2024-03-13 10:57:59 +00:00
internal_binding refactor: Use virtul ops module (#22175) 2024-01-29 22:02:26 +01:00
path chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
readline chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
stream chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
timers chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +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): resolve types via package.json for directory import (#22878) 2024-03-13 22:37:56 -04:00
02_init.js fix(ext/node): make worker ids sequential (#22884) 2024-03-13 19:52:53 +00:00
_brotli.js fix(ext/node): flush brotli decompression stream (#22856) 2024-03-12 17:23:31 +05:30
_events.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_events.mjs fix(ext/node): don't call undefined nextTick fn (#20724) 2023-10-02 14:13:57 +02:00
_global.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_http_agent.mjs refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
_http_common.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_http_outgoing.ts fix(node:http) Export validateHeaderName and validateHeaderValue functions (#22616) 2024-03-10 22:46:05 +00:00
_next_tick.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_readline.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_readline.mjs refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02: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 fix(ext/node): use node:process in _streams.mjs (#21755) 2024-01-02 19:08:05 +01:00
_tls_common.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_tls_wrap.ts fix(ext/node): pass alpnProtocols to Deno.startTls (#22512) 2024-02-21 18:13:01 +05:30
_utils.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_zlib.mjs fix(node/zlib): accept dataview and buffer in zlib bindings (#21756) 2024-01-03 19:03:51 +05:30
_zlib_binding.mjs refactor: migrate 'ext/node' extension to virtual ops module (#22157) 2024-01-29 14:58:08 +01:00
assert.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +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 fix(node): implement ALS enterWith (#22740) 2024-03-06 12:05:57 +00:00
buffer.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
child_process.ts fix(ext/node): strip --enable-source-maps from argv (#22743) 2024-03-06 13:40:47 +00:00
cluster.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
console.ts refactor: split runtime/98_global_scope.js (#21785) 2024-01-06 14:40:26 +01:00
constants.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
crypto.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dgram.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
diagnostics_channel.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dns.ts fix(ext/node): Match punycode module behavior to node (#22847) 2024-03-11 15:49:43 -07:00
domain.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
events.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs.ts feat(node): implement fs.statfs() (#22862) 2024-03-13 10:57:59 +00:00
http.ts fix(node:http) Export validateHeaderName and validateHeaderValue functions (#22616) 2024-03-10 22:46:05 +00:00
http2.ts fix(ext/node): http2.createServer (#22708) 2024-03-07 19:28:46 +05:30
https.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
inspector.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
net.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
os.ts refactor: migrate 'ext/node' extension to virtual ops module (#22157) 2024-01-29 14:58:08 +01:00
path.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
perf_hooks.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
process.ts fix(ext/node): set correct process.argv0 (#22555) 2024-02-23 17:30:29 +01:00
punycode.ts fix(ext/node): Match punycode module behavior to node (#22847) 2024-03-11 15:49:43 -07: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: update commonjs loading docs (#19904) 2023-07-22 05:48:06 +02:00
repl.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
stream.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
string_decoder.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
sys.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
testing.ts fix(node/test): disable Deno test sanitizers (#22480) 2024-02-20 23:22:07 -05:00
timers.ts fix(ext/node): Add Immediate class to mirror NodeJS.Immediate (#22808) 2024-03-08 15:58:43 -08:00
tls.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
tty.js chore: upgrade deno_core (#22725) 2024-03-06 15:08:10 -08:00
url.ts fix(ext/node): Match punycode module behavior to node (#22847) 2024-03-11 15:49:43 -07:00
util.ts fix(node): util.callbackify (#22200) 2024-02-01 08:51:10 +05:30
v8.ts refactor: migrate 'ext/node' extension to virtual ops module (#22157) 2024-01-29 14:58:08 +01:00
vm.ts refactor: migrate 'ext/node' extension to virtual ops module (#22157) 2024-01-29 14:58:08 +01:00
wasi.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
worker_threads.ts fix(ext/node): make worker ids sequential (#22884) 2024-03-13 19:52:53 +00:00
zlib.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00

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 tools/node_compat/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.