1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-23 15:49:44 -05:00
denoland-deno/ext/node/polyfills
Jovi De Croock 08fc8d50e3
fix(node/zlib): cast Dataview and Buffer to uint8 (#21746)
This fixes point 2 of #20516 

This adds a conversion from Dataview/Buffer by returning `obj.buffer`
which can be converted to a `UInt8Array`.

Question: Regarding point 4 of the mentioned issue would it be
appropriate to copy the toU8 helper to the `zlib.mjs` methods?
2023-12-31 17:20:37 +05:30
..
_fs perf(node/fs): faster existsSync when not exists (#21458) 2023-12-04 21:05:40 +00:00
_process refactor: pull 'core', 'internals', 'primordials' from ES module (#21462) 2023-12-07 14:21:01 +01:00
_util fix(ext/node): use primordials in ext/node/polyfills/_util (#21444) 2023-12-08 18:00:03 +09:00
assert refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
dns refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
fs refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
internal chore(runtime): internalize pipe fd for ext/node (#21570) 2023-12-30 05:32:30 +00:00
internal_binding chore: update deno_core to 0.240.0 (#21726) 2023-12-28 19:30:07 +00:00
path chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
readline chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
stream fix(ext/node): fix stream/promises export (#19820) 2023-07-17 22:10:34 +09:00
timers refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
util refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
00_globals.js feat(ext/node): properly segregate node globals (#19307) 2023-07-19 10:30:04 +02:00
01_require.js refactor: pull 'core', 'internals', 'primordials' from ES module (#21462) 2023-12-07 14:21:01 +01:00
02_init.js refactor: setup child process pipe in Rust (#21579) 2023-12-15 11:50:05 +01:00
_brotli.js fix(node/zlib): cast Dataview and Buffer to uint8 (#21746) 2023-12-31 17:20:37 +05:30
_events.d.ts feat(ext/node): embed std/node into the snapshot (#17724) 2023-02-14 17:38:45 +01:00
_events.mjs fix(ext/node): don't call undefined nextTick fn (#20724) 2023-10-02 14:13:57 +02:00
_global.d.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02: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(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
_http_outgoing.ts fix(ext/node): allow null value for req.setHeader (#21391) 2023-12-08 17:43:19 +09:00
_next_tick.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
_readline.d.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02: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 refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
_stream.d.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
_stream.mjs fix(ext/node): fix duplexify compatibility (#21346) 2023-11-28 12:14:57 +09:00
_tls_common.ts feat(ext/node): embed std/node into the snapshot (#17724) 2023-02-14 17:38:45 +01:00
_tls_wrap.ts fix(node/tls): fix NotValidForName for host set via socket / servername (#21441) 2023-12-08 03:53:36 +00:00
_utils.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
_zlib.mjs fix(ext/node): support dictionary option in zlib init (#20035) 2023-08-11 11:42:35 +00:00
_zlib_binding.mjs perf: remove opAsync (#21690) 2023-12-27 02:30:26 +01:00
assert.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
assertion_error.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
async_hooks.ts fix(node/async_hooks): don't pop async context frame if stack if empty (#20077) 2023-08-10 09:00:25 +05:30
buffer.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
child_process.ts refactor: setup child process pipe in Rust (#21579) 2023-12-15 11:50:05 +01:00
cluster.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
console.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
constants.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
crypto.ts fix(node): add crypto.pseudoRandomBytes (#21649) 2023-12-20 07:54:55 +05:30
dgram.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
diagnostics_channel.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
dns.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
domain.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
events.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
fs.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
http.ts perf: remove opAsync (#21690) 2023-12-27 02:30:26 +01:00
http2.ts perf: remove opAsync (#21690) 2023-12-27 02:30:26 +01:00
https.ts fix(node/http): export globalAgent (#21081) 2023-11-11 10:13:30 +05:30
inspector.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
net.ts fix(node/net): Server connection callback include socket value (#19779) 2023-07-19 00:33:43 +02:00
os.ts fix(node): Implement os.cpus() (#21697) 2023-12-28 09:08:50 +05:30
path.ts fix(path): Remove non node symbols (#18630) 2023-04-18 10:44:25 +02:00
perf_hooks.ts fix(ext/node): add APIs perf_hook.performance (#21192) 2023-11-14 16:33:09 +05:30
process.ts fix(ext/node): add process.abort() (#21742) 2023-12-30 20:30:55 +05:30
punycode.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
querystring.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
readline.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
README.md chore: update commonjs loading docs (#19904) 2023-07-22 05:48:06 +02:00
repl.ts fix(node): repl._builtinLibs (#20046) 2023-08-04 14:30:48 +02:00
stream.ts refactor: rename InternalModuleLoader to ExtModuleLoader, use ext: scheme for snapshotted modules (#18041) 2023-03-08 12:44:54 +01:00
string_decoder.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
sys.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
testing.ts fix(node): support nested tests in "node:test" (#21717) 2023-12-29 16:18:08 +01:00
timers.ts refactor: pull 'core', 'internals', 'primordials' from ES module (#21462) 2023-12-07 14:21:01 +01:00
tls.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
tty.js fix(ext/node): tty streams extends net socket (#21026) 2023-10-31 17:24:43 +05:30
url.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
util.ts fix(console): inspect for {Set,Map}Iterator and Weak{Set,Map} (#21554) 2023-12-19 15:05:49 +09:00
v8.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
vm.ts fix(node): return false from vm.isContext (#21568) 2023-12-14 10:19:50 +00:00
wasi.ts chore(ext/node): disable prefer-primordials on a per-file basis (#19553) 2023-06-27 15:18:22 +09:00
worker_threads.ts refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
zlib.ts fix(ext/node): support brotli APIs (#19223) 2023-06-24 19:42:08 +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 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.