summaryrefslogtreecommitdiff
path: root/doc/api/net.md
diff options
context:
space:
mode:
authorMichaël Zasso <targos@protonmail.com>2021-09-04 15:29:35 +0200
committerMichaël Zasso <targos@protonmail.com>2021-09-28 13:27:26 +0200
commitd9ebc04e9bf31bf45c49875c1a689b6401e07009 (patch)
tree02706f1b011a7463fcb2913b2c3d08cf4aaac37c /doc/api/net.md
parent2caa3084857c7471ba979e4ed370ace4e388e545 (diff)
downloadnode-new-d9ebc04e9bf31bf45c49875c1a689b6401e07009.tar.gz
2021-09-28, Version 14.18.0 'Fermium' (LTS)
Notable changes: assert: * change status of legacy asserts (James M Snell) https://github.com/nodejs/node/pull/38113 buffer: * (SEMVER-MINOR) introduce Blob (James M Snell) https://github.com/nodejs/node/pull/36811 * (SEMVER-MINOR) add base64url encoding option (Filip Skokan) https://github.com/nodejs/node/pull/36952 child_process: * (SEMVER-MINOR) allow `options.cwd` receive a URL (Khaidi Chu) https://github.com/nodejs/node/pull/38862 * (SEMVER-MINOR) add timeout to spawn and fork (Nitzan Uziely) https://github.com/nodejs/node/pull/37256 * (SEMVER-MINOR) allow promisified exec to be cancel (Carlos Fuentes) https://github.com/nodejs/node/pull/34249 * (SEMVER-MINOR) add 'overlapped' stdio flag (Thiago Padilha) https://github.com/nodejs/node/pull/29412 cli: * (SEMVER-MINOR) add -C alias for --conditions flag (Guy Bedford) https://github.com/nodejs/node/pull/38755 * (SEMVER-MINOR) add --node-memory-debug option (Anna Henningsen) https://github.com/nodejs/node/pull/35537 dns: * (SEMVER-MINOR) add "tries" option to Resolve options (Luan Devecchi) https://github.com/nodejs/node/pull/39610 * (SEMVER-MINOR) allow `--dns-result-order` to change default dns verbatim (Ouyang Yadong) https://github.com/nodejs/node/pull/38099 doc: * (SEMVER-MINOR) add missing change to resolver ctor (Luan Devecchi) https://github.com/nodejs/node/pull/39610 * refactor fs docs structure (James M Snell) https://github.com/nodejs/node/pull/37170 errors: * (SEMVER-MINOR) remove experimental from --enable-source-maps (Benjamin Coe) https://github.com/nodejs/node/pull/37362 esm: * deprecate legacy main lookup for modules (Guy Bedford) https://github.com/nodejs/node/pull/36918 fs: * (SEMVER-MINOR) allow empty string for temp directory prefix (Voltrex) https://github.com/nodejs/node/pull/39028 * (SEMVER-MINOR) allow no-params fsPromises fileHandle read (Nitzan Uziely) https://github.com/nodejs/node/pull/38287 * (SEMVER-MINOR) add support for async iterators to `fsPromises.writeFile` (HiroyukiYagihashi) https://github.com/nodejs/node/pull/37490 * improve fsPromises readFile performance (Nitzan Uziely) https://github.com/nodejs/node/pull/37608 * (SEMVER-MINOR) add fsPromises.watch() (James M Snell) https://github.com/nodejs/node/pull/37179 * (SEMVER-MINOR) allow `position` parameter to be a `BigInt` in read and readSync (Darshan Sen) https://github.com/nodejs/node/pull/36190 http2: * (SEMVER-MINOR) add support for sensitive headers (Anna Henningsen) https://github.com/nodejs/node/pull/34145 * (SEMVER-MINOR) allow setting the local window size of a session (Yongsheng Zhang) https://github.com/nodejs/node/pull/35978 inspector: * mark as stable (Gireesh Punathil) https://github.com/nodejs/node/pull/37748 module: * (SEMVER-MINOR) add support for `URL` to `import.meta.resolve` (Antoine du Hamel) https://github.com/nodejs/node/pull/38587 * (SEMVER-MINOR) add support for `node:`‑prefixed `require(…)` calls (ExE Boss) https://github.com/nodejs/node/pull/37246 net: * (SEMVER-MINOR) introduce net.BlockList (James M Snell) https://github.com/nodejs/node/pull/34625 node-api: * (SEMVER-MINOR) allow retrieval of add-on file name (Gabriel Schulhof) https://github.com/nodejs/node/pull/37195 os: * (SEMVER-MINOR) add os.devNull (Luigi Pinca) https://github.com/nodejs/node/pull/38569 perf_hooks: * (SEMVER-MINOR) introduce createHistogram (James M Snell) https://github.com/nodejs/node/pull/37155 process: * (SEMVER-MINOR) add api to enable source-maps programmatically (legendecas) https://github.com/nodejs/node/pull/39085 * (SEMVER-MINOR) add `'worker'` event (James M Snell) https://github.com/nodejs/node/pull/38659 * (SEMVER-MINOR) add direct access to rss without iterating pages (Adrien Maret) https://github.com/nodejs/node/pull/34291 readline: * (SEMVER-MINOR) add AbortSignal support to interface (Nitzan Uziely) https://github.com/nodejs/node/pull/37932 * (SEMVER-MINOR) add support for the AbortController to the question method (Mattias Runge-Broberg) https://github.com/nodejs/node/pull/33676 * (SEMVER-MINOR) add history event and option to set initial history (Mattias Runge-Broberg) https://github.com/nodejs/node/pull/33662 repl: * (SEMVER-MINOR) add auto‑completion for `node:`‑prefixed `require(…)` calls (ExE Boss) https://github.com/nodejs/node/pull/37246 src: * (SEMVER-MINOR) call overload ctor from the original ctor (Darshan Sen) https://github.com/nodejs/node/pull/39768 * (SEMVER-MINOR) add a constructor overload for CallbackScope (Darshan Sen) https://github.com/nodejs/node/pull/39768 * (SEMVER-MINOR) allow to negate boolean CLI flags (Michaël Zasso) https://github.com/nodejs/node/pull/39023 * (SEMVER-MINOR) add --heapsnapshot-near-heap-limit option (Joyee Cheung) https://github.com/nodejs/node/pull/33010 * (SEMVER-MINOR) add way to get IsolateData and allocator from Environment (Anna Henningsen) https://github.com/nodejs/node/pull/36441 * (SEMVER-MINOR) allow preventing SetPrepareStackTraceCallback (Shelley Vohr) https://github.com/nodejs/node/pull/36447 * (SEMVER-MINOR) add maybe versions of EmitExit and EmitBeforeExit (Anna Henningsen) https://github.com/nodejs/node/pull/35486 stream: * (SEMVER-MINOR) add readableDidRead if has been read from (Robert Nagy) https://github.com/nodejs/node/pull/39589 * (SEMVER-MINOR) pipeline accept Buffer as a valid first argument (Nitzan Uziely) https://github.com/nodejs/node/pull/37739 tls: * (SEMVER-MINOR) allow reading data into a static buffer (Andrey Pechkurov) https://github.com/nodejs/node/pull/35753 tools: * (SEMVER-MINOR) add `Worker` to type-parser (James M Snell) https://github.com/nodejs/node/pull/38659 url: * (SEMVER-MINOR) expose urlToHttpOptions utility (Yongsheng Zhang) https://github.com/nodejs/node/pull/35960 util: * (SEMVER-MINOR) expose toUSVString (Robert Nagy) https://github.com/nodejs/node/pull/39814 v8: * (SEMVER-MINOR) implement v8.stopCoverage() (Joyee Cheung) https://github.com/nodejs/node/pull/33807 * (SEMVER-MINOR) implement v8.takeCoverage() (Joyee Cheung) https://github.com/nodejs/node/pull/33807 worker: * (SEMVER-MINOR) add setEnvironmentData/getEnvironmentData (James M Snell) https://github.com/nodejs/node/pull/37486 PR-URL: https://github.com/nodejs/node/pull/39990
Diffstat (limited to 'doc/api/net.md')
-rw-r--r--doc/api/net.md48
1 files changed, 36 insertions, 12 deletions
diff --git a/doc/api/net.md b/doc/api/net.md
index 1b662f0502..6d5487b674 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -58,7 +58,9 @@ net.createServer().listen(
## Class: `net.BlockList`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
The `BlockList` object can be used with some network APIs to specify rules for
@@ -67,7 +69,9 @@ IP subnets.
### `blockList.addAddress(address[, type])`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
* `address` {string|net.SocketAddress} An IPv4 or IPv6 address.
@@ -77,7 +81,9 @@ Adds a rule to block the given IP address.
### `blockList.addRange(start, end[, type])`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
* `start` {string|net.SocketAddress} The starting IPv4 or IPv6 address in the
@@ -90,7 +96,9 @@ Adds a rule to block a range of IP addresses from `start` (inclusive) to
### `blockList.addSubnet(net, prefix[, type])`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
* `net` {string|net.SocketAddress} The network IPv4 or IPv6 address.
@@ -103,7 +111,9 @@ Adds a rule to block a range of IP addresses specified as a subnet mask.
### `blockList.check(address[, type])`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
* `address` {string|net.SocketAddress} The IP address to check
@@ -130,7 +140,9 @@ console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true
### `blockList.rules`
<!-- YAML
-added: v15.0.0
+added:
+ - v15.0.0
+ - v14.18.0
-->
* Type: {string[]}
@@ -139,11 +151,15 @@ The list of rules added to the blocklist.
## Class: `net.SocketAddress`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
### `new net.SocketAddress([options])`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
* `options` {Object}
@@ -156,28 +172,36 @@ added: v15.14.0
### `socketaddress.address`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
* Type {string}
### `socketaddress.family`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
* Type {string} Either `'ipv4'` or `'ipv6'`.
### `socketaddress.flowlabel`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
* Type {number}
### `socketaddress.port`
<!-- YAML
-added: v15.14.0
+added:
+ - v15.14.0
+ - v14.18.0
-->
* Type {number}