@types/node 20.14.13 → 22.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- node v20.14/README.md → node/README.md +2 -2
- node v20.14/assert.d.ts → node/assert.d.ts +5 -5
- node v20.14/async_hooks.d.ts → node/async_hooks.d.ts +5 -5
- node v20.14/buffer.d.ts → node/buffer.d.ts +1 -1
- node v20.14/child_process.d.ts → node/child_process.d.ts +2 -2
- node v20.14/cluster.d.ts → node/cluster.d.ts +15 -15
- node v20.14/console.d.ts → node/console.d.ts +17 -17
- node v20.14/crypto.d.ts → node/crypto.d.ts +5 -78
- node v20.14/dgram.d.ts → node/dgram.d.ts +1 -1
- node v20.14/diagnostics_channel.d.ts → node/diagnostics_channel.d.ts +1 -1
- node v20.14/dns/promises.d.ts → node/dns/promises.d.ts +10 -10
- node v20.14/dns.d.ts → node/dns.d.ts +24 -36
- node v20.14/domain.d.ts → node/domain.d.ts +1 -1
- node v20.14/events.d.ts → node/events.d.ts +1 -1
- node v20.14/fs/promises.d.ts → node/fs/promises.d.ts +5 -0
- node v20.14/fs.d.ts → node/fs.d.ts +32 -2
- node v20.14/http.d.ts → node/http.d.ts +2 -2
- node v20.14/http2.d.ts → node/http2.d.ts +2 -2
- node v20.14/https.d.ts → node/https.d.ts +1 -1
- node v20.14/inspector.d.ts → node/inspector.d.ts +1 -1
- node v20.14/module.d.ts → node/module.d.ts +0 -14
- node v20.14/net.d.ts → node/net.d.ts +1 -1
- node v20.14/os.d.ts → node/os.d.ts +3 -3
- node v20.14/package.json → node/package.json +3 -3
- node v20.14/path.d.ts → node/path.d.ts +1 -1
- node v20.14/perf_hooks.d.ts → node/perf_hooks.d.ts +8 -8
- node v20.14/process.d.ts → node/process.d.ts +2 -2
- node v20.14/punycode.d.ts → node/punycode.d.ts +1 -1
- node v20.14/querystring.d.ts → node/querystring.d.ts +1 -1
- node v20.14/readline.d.ts → node/readline.d.ts +10 -10
- node v20.14/repl.d.ts → node/repl.d.ts +12 -12
- node v20.14/sea.d.ts → node/sea.d.ts +1 -1
- node v20.14/stream.d.ts → node/stream.d.ts +9 -9
- node v20.14/string_decoder.d.ts → node/string_decoder.d.ts +1 -1
- node v20.14/test.d.ts → node/test.d.ts +10 -10
- node v20.14/timers.d.ts → node/timers.d.ts +1 -1
- node v20.14/tls.d.ts → node/tls.d.ts +2 -2
- node v20.14/trace_events.d.ts → node/trace_events.d.ts +6 -6
- node v20.14/tty.d.ts → node/tty.d.ts +1 -1
- node v20.14/url.d.ts → node/url.d.ts +3 -11
- node v20.14/util.d.ts → node/util.d.ts +2 -2
- node v20.14/v8.d.ts → node/v8.d.ts +2 -2
- node v20.14/vm.d.ts → node/vm.d.ts +5 -7
- node v20.14/wasi.d.ts → node/wasi.d.ts +1 -1
- node v20.14/worker_threads.d.ts → node/worker_threads.d.ts +1 -1
- node v20.14/zlib.d.ts → node/zlib.d.ts +3 -3
- {node v20.14 → node}/LICENSE +0 -0
- {node v20.14 → node}/assert/strict.d.ts +0 -0
- {node v20.14 → node}/constants.d.ts +0 -0
- {node v20.14 → node}/dom-events.d.ts +0 -0
- {node v20.14 → node}/globals.d.ts +0 -0
- {node v20.14 → node}/globals.global.d.ts +0 -0
- {node v20.14 → node}/index.d.ts +0 -0
- {node v20.14 → node}/readline/promises.d.ts +0 -0
- {node v20.14 → node}/stream/consumers.d.ts +0 -0
- {node v20.14 → node}/stream/promises.d.ts +0 -0
- {node v20.14 → node}/stream/web.d.ts +0 -0
- {node v20.14 → node}/timers/promises.d.ts +0 -0
@@ -5,10 +5,10 @@
|
|
5
5
|
This package contains type definitions for node (https://nodejs.org/).
|
6
6
|
|
7
7
|
# Details
|
8
|
-
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node
|
8
|
+
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
|
9
9
|
|
10
10
|
### Additional Details
|
11
|
-
* Last updated:
|
11
|
+
* Last updated: Wed, 31 Jul 2024 17:36:20 GMT
|
12
12
|
* Dependencies: [undici-types](https://npmjs.com/package/undici-types)
|
13
13
|
|
14
14
|
# Credits
|
@@ -1,7 +1,7 @@
|
|
1
1
|
/**
|
2
2
|
* The `node:assert` module provides a set of assertion functions for verifying
|
3
3
|
* invariants.
|
4
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
4
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/assert.js)
|
5
5
|
*/
|
6
6
|
declare module "assert" {
|
7
7
|
/**
|
@@ -796,7 +796,7 @@ declare module "assert" {
|
|
796
796
|
* check that the promise is rejected.
|
797
797
|
*
|
798
798
|
* If `asyncFn` is a function and it throws an error synchronously, `assert.rejects()` will return a rejected `Promise` with that error. If the
|
799
|
-
* function does not return a promise, `assert.rejects()` will return a rejected `Promise` with an [ERR_INVALID_RETURN_VALUE](https://nodejs.org/docs/latest-
|
799
|
+
* function does not return a promise, `assert.rejects()` will return a rejected `Promise` with an [ERR_INVALID_RETURN_VALUE](https://nodejs.org/docs/latest-v22.x/api/errors.html#err_invalid_return_value)
|
800
800
|
* error. In both cases the error handler is skipped.
|
801
801
|
*
|
802
802
|
* Besides the async nature to await the completion behaves identically to {@link throws}.
|
@@ -866,7 +866,7 @@ declare module "assert" {
|
|
866
866
|
*
|
867
867
|
* If `asyncFn` is a function and it throws an error synchronously, `assert.doesNotReject()` will return a rejected `Promise` with that error. If
|
868
868
|
* the function does not return a promise, `assert.doesNotReject()` will return a
|
869
|
-
* rejected `Promise` with an [ERR_INVALID_RETURN_VALUE](https://nodejs.org/docs/latest-
|
869
|
+
* rejected `Promise` with an [ERR_INVALID_RETURN_VALUE](https://nodejs.org/docs/latest-v22.x/api/errors.html#err_invalid_return_value) error. In both cases
|
870
870
|
* the error handler is skipped.
|
871
871
|
*
|
872
872
|
* Using `assert.doesNotReject()` is actually not useful because there is little
|
@@ -929,7 +929,7 @@ declare module "assert" {
|
|
929
929
|
* If the values do not match, or if the `string` argument is of another type than `string`, an `{@link AssertionError}` is thrown with a `message` property set equal
|
930
930
|
* to the value of the `message` parameter. If the `message` parameter is
|
931
931
|
* undefined, a default error message is assigned. If the `message` parameter is an
|
932
|
-
* instance of an [Error](https://nodejs.org/docs/latest-
|
932
|
+
* instance of an [Error](https://nodejs.org/docs/latest-v22.x/api/errors.html#class-error) then it will be thrown instead of the `{@link AssertionError}`.
|
933
933
|
* @since v13.6.0, v12.16.0
|
934
934
|
*/
|
935
935
|
function match(value: string, regExp: RegExp, message?: string | Error): void;
|
@@ -952,7 +952,7 @@ declare module "assert" {
|
|
952
952
|
* If the values do match, or if the `string` argument is of another type than `string`, an `{@link AssertionError}` is thrown with a `message` property set equal
|
953
953
|
* to the value of the `message` parameter. If the `message` parameter is
|
954
954
|
* undefined, a default error message is assigned. If the `message` parameter is an
|
955
|
-
* instance of an [Error](https://nodejs.org/docs/latest-
|
955
|
+
* instance of an [Error](https://nodejs.org/docs/latest-v22.x/api/errors.html#class-error) then it will be thrown instead of the `{@link AssertionError}`.
|
956
956
|
* @since v13.6.0, v12.16.0
|
957
957
|
*/
|
958
958
|
function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void;
|
@@ -2,8 +2,8 @@
|
|
2
2
|
* We strongly discourage the use of the `async_hooks` API.
|
3
3
|
* Other APIs that can cover most of its use cases include:
|
4
4
|
*
|
5
|
-
* * [`AsyncLocalStorage`](https://nodejs.org/docs/latest-
|
6
|
-
* * [`process.getActiveResourcesInfo()`](https://nodejs.org/docs/latest-
|
5
|
+
* * [`AsyncLocalStorage`](https://nodejs.org/docs/latest-v22.x/api/async_context.html#class-asynclocalstorage) tracks async context
|
6
|
+
* * [`process.getActiveResourcesInfo()`](https://nodejs.org/docs/latest-v22.x/api/process.html#processgetactiveresourcesinfo) tracks active resources
|
7
7
|
*
|
8
8
|
* The `node:async_hooks` module provides an API to track asynchronous resources.
|
9
9
|
* It can be accessed using:
|
@@ -12,7 +12,7 @@
|
|
12
12
|
* import async_hooks from 'node:async_hooks';
|
13
13
|
* ```
|
14
14
|
* @experimental
|
15
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
15
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/async_hooks.js)
|
16
16
|
*/
|
17
17
|
declare module "async_hooks" {
|
18
18
|
/**
|
@@ -44,7 +44,7 @@ declare module "async_hooks" {
|
|
44
44
|
* ```
|
45
45
|
*
|
46
46
|
* Promise contexts may not get precise `executionAsyncIds` by default.
|
47
|
-
* See the section on [promise execution tracking](https://nodejs.org/docs/latest-
|
47
|
+
* See the section on [promise execution tracking](https://nodejs.org/docs/latest-v22.x/api/async_hooks.html#promise-execution-tracking).
|
48
48
|
* @since v8.1.0
|
49
49
|
* @return The `asyncId` of the current execution context. Useful to track when something calls.
|
50
50
|
*/
|
@@ -117,7 +117,7 @@ declare module "async_hooks" {
|
|
117
117
|
* ```
|
118
118
|
*
|
119
119
|
* Promise contexts may not get valid `triggerAsyncId`s by default. See
|
120
|
-
* the section on [promise execution tracking](https://nodejs.org/docs/latest-
|
120
|
+
* the section on [promise execution tracking](https://nodejs.org/docs/latest-v22.x/api/async_hooks.html#promise-execution-tracking).
|
121
121
|
* @return The ID of the resource responsible for calling the callback that is currently being executed.
|
122
122
|
*/
|
123
123
|
function triggerAsyncId(): number;
|
@@ -41,7 +41,7 @@
|
|
41
41
|
* // Creates a Buffer containing the Latin-1 bytes [0x74, 0xe9, 0x73, 0x74].
|
42
42
|
* const buf7 = Buffer.from('tést', 'latin1');
|
43
43
|
* ```
|
44
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
44
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/buffer.js)
|
45
45
|
*/
|
46
46
|
declare module "buffer" {
|
47
47
|
import { BinaryLike } from "node:crypto";
|
@@ -63,7 +63,7 @@
|
|
63
63
|
* For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however,
|
64
64
|
* the synchronous methods can have significant impact on performance due to
|
65
65
|
* stalling the event loop while spawned processes complete.
|
66
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
66
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/child_process.js)
|
67
67
|
*/
|
68
68
|
declare module "child_process" {
|
69
69
|
import { ObjectEncodingOptions } from "node:fs";
|
@@ -455,7 +455,7 @@ declare module "child_process" {
|
|
455
455
|
* as the connection may have been closed during the time it takes to send the
|
456
456
|
* connection to the child.
|
457
457
|
* @since v0.5.9
|
458
|
-
* @param sendHandle `undefined`, or a [`net.Socket`](https://nodejs.org/docs/latest-
|
458
|
+
* @param sendHandle `undefined`, or a [`net.Socket`](https://nodejs.org/docs/latest-v22.x/api/net.html#class-netsocket), [`net.Server`](https://nodejs.org/docs/latest-v22.x/api/net.html#class-netserver), or [`dgram.Socket`](https://nodejs.org/docs/latest-v22.x/api/dgram.html#class-dgramsocket) object.
|
459
459
|
* @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
|
460
460
|
*/
|
461
461
|
send(message: Serializable, callback?: (error: Error | null) => void): boolean;
|
@@ -1,7 +1,7 @@
|
|
1
1
|
/**
|
2
2
|
* Clusters of Node.js processes can be used to run multiple instances of Node.js
|
3
3
|
* that can distribute workloads among their application threads. When process isolation
|
4
|
-
* is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-
|
4
|
+
* is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v22.x/api/worker_threads.html)
|
5
5
|
* module instead, which allows running multiple application threads within a single Node.js instance.
|
6
6
|
*
|
7
7
|
* The cluster module allows easy creation of child processes that all share
|
@@ -50,7 +50,7 @@
|
|
50
50
|
* ```
|
51
51
|
*
|
52
52
|
* On Windows, it is not yet possible to set up a named pipe server in a worker.
|
53
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
53
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/cluster.js)
|
54
54
|
*/
|
55
55
|
declare module "cluster" {
|
56
56
|
import * as child from "node:child_process";
|
@@ -80,8 +80,8 @@ declare module "cluster" {
|
|
80
80
|
silent?: boolean | undefined;
|
81
81
|
/**
|
82
82
|
* Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
|
83
|
-
* contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-
|
84
|
-
* [`stdio`](https://nodejs.org/docs/latest-
|
83
|
+
* contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v22.x/api/child_process.html#child_processspawncommand-args-options)'s
|
84
|
+
* [`stdio`](https://nodejs.org/docs/latest-v22.x/api/child_process.html#optionsstdio).
|
85
85
|
*/
|
86
86
|
stdio?: any[] | undefined;
|
87
87
|
/**
|
@@ -99,7 +99,7 @@ declare module "cluster" {
|
|
99
99
|
inspectPort?: number | (() => number) | undefined;
|
100
100
|
/**
|
101
101
|
* Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
|
102
|
-
* See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-
|
102
|
+
* See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v22.x/api/child_process.html#advanced-serialization) for more details.
|
103
103
|
* @default false
|
104
104
|
*/
|
105
105
|
serialization?: SerializationType | undefined;
|
@@ -142,10 +142,10 @@ declare module "cluster" {
|
|
142
142
|
*/
|
143
143
|
id: number;
|
144
144
|
/**
|
145
|
-
* All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-
|
145
|
+
* All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v22.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
|
146
146
|
* from this function is stored as `.process`. In a worker, the global `process` is stored.
|
147
147
|
*
|
148
|
-
* See: [Child Process module](https://nodejs.org/docs/latest-
|
148
|
+
* See: [Child Process module](https://nodejs.org/docs/latest-v22.x/api/child_process.html#child_processforkmodulepath-args-options).
|
149
149
|
*
|
150
150
|
* Workers will call `process.exit(0)` if the `'disconnect'` event occurs
|
151
151
|
* on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
|
@@ -156,7 +156,7 @@ declare module "cluster" {
|
|
156
156
|
/**
|
157
157
|
* Send a message to a worker or primary, optionally with a handle.
|
158
158
|
*
|
159
|
-
* In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-
|
159
|
+
* In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v22.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
|
160
160
|
*
|
161
161
|
* In a worker, this sends a message to the primary. It is identical to `process.send()`.
|
162
162
|
*
|
@@ -198,7 +198,7 @@ declare module "cluster" {
|
|
198
198
|
* This method is aliased as `worker.destroy()` for backwards compatibility.
|
199
199
|
*
|
200
200
|
* In a worker, `process.kill()` exists, but it is not this function;
|
201
|
-
* it is [`kill()`](https://nodejs.org/docs/latest-
|
201
|
+
* it is [`kill()`](https://nodejs.org/docs/latest-v22.x/api/process.html#processkillpid-signal).
|
202
202
|
* @since v0.9.12
|
203
203
|
* @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
|
204
204
|
*/
|
@@ -411,7 +411,7 @@ declare module "cluster" {
|
|
411
411
|
readonly isWorker: boolean;
|
412
412
|
/**
|
413
413
|
* The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
|
414
|
-
* global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-
|
414
|
+
* global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clustersetupprimarysettings)
|
415
415
|
* is called, whichever comes first.
|
416
416
|
*
|
417
417
|
* `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
|
@@ -422,24 +422,24 @@ declare module "cluster" {
|
|
422
422
|
*/
|
423
423
|
schedulingPolicy: number;
|
424
424
|
/**
|
425
|
-
* After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-
|
426
|
-
* (or [`.fork()`](https://nodejs.org/docs/latest-
|
425
|
+
* After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clustersetupprimarysettings)
|
426
|
+
* (or [`.fork()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clusterforkenv)) this settings object will contain
|
427
427
|
* the settings, including the default values.
|
428
428
|
*
|
429
429
|
* This object is not intended to be changed or set manually.
|
430
430
|
* @since v0.7.1
|
431
431
|
*/
|
432
432
|
readonly settings: ClusterSettings;
|
433
|
-
/** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-
|
433
|
+
/** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clustersetupprimarysettings) instead. */
|
434
434
|
setupMaster(settings?: ClusterSettings): void;
|
435
435
|
/**
|
436
436
|
* `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
|
437
437
|
*
|
438
|
-
* Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-
|
438
|
+
* Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clusterforkenv)
|
439
439
|
* and have no effect on workers that are already running.
|
440
440
|
*
|
441
441
|
* The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
|
442
|
-
* [`.fork()`](https://nodejs.org/docs/latest-
|
442
|
+
* [`.fork()`](https://nodejs.org/docs/latest-v22.x/api/cluster.html#clusterforkenv).
|
443
443
|
*
|
444
444
|
* The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
|
445
445
|
* `cluster.setupPrimary()` is called.
|
@@ -5,12 +5,12 @@
|
|
5
5
|
* The module exports two specific components:
|
6
6
|
*
|
7
7
|
* * A `Console` class with methods such as `console.log()`, `console.error()`, and `console.warn()` that can be used to write to any Node.js stream.
|
8
|
-
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-
|
9
|
-
* [`process.stderr`](https://nodejs.org/docs/latest-
|
8
|
+
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstdout) and
|
9
|
+
* [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without calling `require('node:console')`.
|
10
10
|
*
|
11
11
|
* _**Warning**_: The global console object's methods are neither consistently
|
12
12
|
* synchronous like the browser APIs they resemble, nor are they consistently
|
13
|
-
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-
|
13
|
+
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v22.x/api/process.html#a-note-on-process-io) for
|
14
14
|
* more information.
|
15
15
|
*
|
16
16
|
* Example using the global `console`:
|
@@ -54,7 +54,7 @@
|
|
54
54
|
* myConsole.warn(`Danger ${name}! Danger!`);
|
55
55
|
* // Prints: Danger Will Robinson! Danger!, to err
|
56
56
|
* ```
|
57
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
57
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/console.js)
|
58
58
|
*/
|
59
59
|
declare module "console" {
|
60
60
|
import console = require("node:console");
|
@@ -70,7 +70,7 @@ declare module "node:console" {
|
|
70
70
|
* `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
|
71
71
|
* writes a message and does not otherwise affect execution. The output always
|
72
72
|
* starts with `"Assertion failed"`. If provided, `message` is formatted using
|
73
|
-
* [`util.format()`](https://nodejs.org/docs/latest-
|
73
|
+
* [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args).
|
74
74
|
*
|
75
75
|
* If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
|
76
76
|
*
|
@@ -152,7 +152,7 @@ declare module "node:console" {
|
|
152
152
|
*/
|
153
153
|
debug(message?: any, ...optionalParams: any[]): void;
|
154
154
|
/**
|
155
|
-
* Uses [`util.inspect()`](https://nodejs.org/docs/latest-
|
155
|
+
* Uses [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options) on `obj` and prints the resulting string to `stdout`.
|
156
156
|
* This function bypasses any custom `inspect()` function defined on `obj`.
|
157
157
|
* @since v0.1.101
|
158
158
|
*/
|
@@ -167,7 +167,7 @@ declare module "node:console" {
|
|
167
167
|
* Prints to `stderr` with newline. Multiple arguments can be passed, with the
|
168
168
|
* first used as the primary message and all additional used as substitution
|
169
169
|
* values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
|
170
|
-
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-
|
170
|
+
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)).
|
171
171
|
*
|
172
172
|
* ```js
|
173
173
|
* const code = 5;
|
@@ -178,8 +178,8 @@ declare module "node:console" {
|
|
178
178
|
* ```
|
179
179
|
*
|
180
180
|
* If formatting elements (e.g. `%d`) are not found in the first string then
|
181
|
-
* [`util.inspect()`](https://nodejs.org/docs/latest-
|
182
|
-
* resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-
|
181
|
+
* [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options) is called on each argument and the
|
182
|
+
* resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)
|
183
183
|
* for more information.
|
184
184
|
* @since v0.1.100
|
185
185
|
*/
|
@@ -211,7 +211,7 @@ declare module "node:console" {
|
|
211
211
|
* Prints to `stdout` with newline. Multiple arguments can be passed, with the
|
212
212
|
* first used as the primary message and all additional used as substitution
|
213
213
|
* values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
|
214
|
-
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-
|
214
|
+
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)).
|
215
215
|
*
|
216
216
|
* ```js
|
217
217
|
* const count = 5;
|
@@ -221,7 +221,7 @@ declare module "node:console" {
|
|
221
221
|
* // Prints: count: 5, to stdout
|
222
222
|
* ```
|
223
223
|
*
|
224
|
-
* See [`util.format()`](https://nodejs.org/docs/latest-
|
224
|
+
* See [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args) for more information.
|
225
225
|
* @since v0.1.100
|
226
226
|
*/
|
227
227
|
log(message?: any, ...optionalParams: any[]): void;
|
@@ -297,7 +297,7 @@ declare module "node:console" {
|
|
297
297
|
*/
|
298
298
|
timeLog(label?: string, ...data: any[]): void;
|
299
299
|
/**
|
300
|
-
* Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-
|
300
|
+
* Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilformatformat-args)
|
301
301
|
* formatted message and stack trace to the current position in the code.
|
302
302
|
*
|
303
303
|
* ```js
|
@@ -361,12 +361,12 @@ declare module "node:console" {
|
|
361
361
|
* The module exports two specific components:
|
362
362
|
*
|
363
363
|
* * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream.
|
364
|
-
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-
|
365
|
-
* [`process.stderr`](https://nodejs.org/docs/latest-
|
364
|
+
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstdout) and
|
365
|
+
* [`process.stderr`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstderr). The global `console` can be used without calling `require('console')`.
|
366
366
|
*
|
367
367
|
* _**Warning**_: The global console object's methods are neither consistently
|
368
368
|
* synchronous like the browser APIs they resemble, nor are they consistently
|
369
|
-
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-
|
369
|
+
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v22.x/api/process.html#a-note-on-process-io) for
|
370
370
|
* more information.
|
371
371
|
*
|
372
372
|
* Example using the global `console`:
|
@@ -410,7 +410,7 @@ declare module "node:console" {
|
|
410
410
|
* myConsole.warn(`Danger ${name}! Danger!`);
|
411
411
|
* // Prints: Danger Will Robinson! Danger!, to err
|
412
412
|
* ```
|
413
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
413
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/console.js)
|
414
414
|
*/
|
415
415
|
namespace console {
|
416
416
|
interface ConsoleConstructorOptions {
|
@@ -431,7 +431,7 @@ declare module "node:console" {
|
|
431
431
|
colorMode?: boolean | "auto" | undefined;
|
432
432
|
/**
|
433
433
|
* Specifies options that are passed along to
|
434
|
-
* [`util.inspect()`](https://nodejs.org/docs/latest-
|
434
|
+
* [`util.inspect()`](https://nodejs.org/docs/latest-v22.x/api/util.html#utilinspectobject-options).
|
435
435
|
*/
|
436
436
|
inspectOptions?: InspectOptions | undefined;
|
437
437
|
/**
|
@@ -14,7 +14,7 @@
|
|
14
14
|
* // Prints:
|
15
15
|
* // c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e
|
16
16
|
* ```
|
17
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
17
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/crypto.js)
|
18
18
|
*/
|
19
19
|
declare module "crypto" {
|
20
20
|
import * as stream from "node:stream";
|
@@ -96,7 +96,7 @@ declare module "crypto" {
|
|
96
96
|
verifySpkac(spkac: NodeJS.ArrayBufferView): boolean;
|
97
97
|
}
|
98
98
|
namespace constants {
|
99
|
-
// https://nodejs.org/dist/latest-
|
99
|
+
// https://nodejs.org/dist/latest-v22.x/docs/api/crypto.html#crypto-constants
|
100
100
|
const OPENSSL_VERSION_NUMBER: number;
|
101
101
|
/** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */
|
102
102
|
const SSL_OP_ALL: number;
|
@@ -688,48 +688,6 @@ declare module "crypto" {
|
|
688
688
|
interface CipherOCBOptions extends stream.TransformOptions {
|
689
689
|
authTagLength: number;
|
690
690
|
}
|
691
|
-
/**
|
692
|
-
* Creates and returns a `Cipher` object that uses the given `algorithm` and `password`.
|
693
|
-
*
|
694
|
-
* The `options` argument controls stream behavior and is optional except when a
|
695
|
-
* cipher in CCM or OCB mode (e.g. `'aes-128-ccm'`) is used. In that case, the`authTagLength` option is required and specifies the length of the
|
696
|
-
* authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to set the length of the authentication
|
697
|
-
* tag that will be returned by `getAuthTag()` and defaults to 16 bytes.
|
698
|
-
* For `chacha20-poly1305`, the `authTagLength` option defaults to 16 bytes.
|
699
|
-
*
|
700
|
-
* The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
|
701
|
-
* recent OpenSSL releases, `openssl list -cipher-algorithms` will
|
702
|
-
* display the available cipher algorithms.
|
703
|
-
*
|
704
|
-
* The `password` is used to derive the cipher key and initialization vector (IV).
|
705
|
-
* The value must be either a `'latin1'` encoded string, a `Buffer`, a`TypedArray`, or a `DataView`.
|
706
|
-
*
|
707
|
-
* **This function is semantically insecure for all**
|
708
|
-
* **supported ciphers and fatally flawed for ciphers in counter mode (such as CTR,**
|
709
|
-
* **GCM, or CCM).**
|
710
|
-
*
|
711
|
-
* The implementation of `crypto.createCipher()` derives keys using the OpenSSL
|
712
|
-
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
713
|
-
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
714
|
-
* password always creates the same key. The low iteration count and
|
715
|
-
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
716
|
-
* rapidly.
|
717
|
-
*
|
718
|
-
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
719
|
-
* developers derive a key and IV on
|
720
|
-
* their own using {@link scrypt} and to use {@link createCipheriv} to create the `Cipher` object. Users should not use ciphers with counter mode
|
721
|
-
* (e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when
|
722
|
-
* they are used in order to avoid the risk of IV reuse that causes
|
723
|
-
* vulnerabilities. For the case when IV is reused in GCM, see [Nonce-Disrespecting Adversaries](https://github.com/nonce-disrespect/nonce-disrespect) for details.
|
724
|
-
* @since v0.1.94
|
725
|
-
* @deprecated Since v10.0.0 - Use {@link createCipheriv} instead.
|
726
|
-
* @param options `stream.transform` options
|
727
|
-
*/
|
728
|
-
function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM;
|
729
|
-
/** @deprecated since v10.0.0 use `createCipheriv()` */
|
730
|
-
function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM;
|
731
|
-
/** @deprecated since v10.0.0 use `createCipheriv()` */
|
732
|
-
function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher;
|
733
691
|
/**
|
734
692
|
* Creates and returns a `Cipher` object, with the given `algorithm`, `key` and
|
735
693
|
* initialization vector (`iv`).
|
@@ -793,7 +751,7 @@ declare module "crypto" {
|
|
793
751
|
* * Using the `cipher.update()` and `cipher.final()` methods to produce
|
794
752
|
* the encrypted data.
|
795
753
|
*
|
796
|
-
* The {@link
|
754
|
+
* The {@link createCipheriv} method is
|
797
755
|
* used to create `Cipher` instances. `Cipher` objects are not to be created
|
798
756
|
* directly using the `new` keyword.
|
799
757
|
*
|
@@ -977,37 +935,6 @@ declare module "crypto" {
|
|
977
935
|
): this;
|
978
936
|
getAuthTag(): Buffer;
|
979
937
|
}
|
980
|
-
/**
|
981
|
-
* Creates and returns a `Decipher` object that uses the given `algorithm` and `password` (key).
|
982
|
-
*
|
983
|
-
* The `options` argument controls stream behavior and is optional except when a
|
984
|
-
* cipher in CCM or OCB mode (e.g. `'aes-128-ccm'`) is used. In that case, the `authTagLength` option is required and specifies the length of the
|
985
|
-
* authentication tag in bytes, see `CCM mode`.
|
986
|
-
* For `chacha20-poly1305`, the `authTagLength` option defaults to 16 bytes.
|
987
|
-
*
|
988
|
-
* **This function is semantically insecure for all**
|
989
|
-
* **supported ciphers and fatally flawed for ciphers in counter mode (such as CTR,**
|
990
|
-
* **GCM, or CCM).**
|
991
|
-
*
|
992
|
-
* The implementation of `crypto.createDecipher()` derives keys using the OpenSSL
|
993
|
-
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
994
|
-
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
995
|
-
* password always creates the same key. The low iteration count and
|
996
|
-
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
997
|
-
* rapidly.
|
998
|
-
*
|
999
|
-
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
1000
|
-
* developers derive a key and IV on
|
1001
|
-
* their own using {@link scrypt} and to use {@link createDecipheriv} to create the `Decipher` object.
|
1002
|
-
* @since v0.1.94
|
1003
|
-
* @deprecated Since v10.0.0 - Use {@link createDecipheriv} instead.
|
1004
|
-
* @param options `stream.transform` options
|
1005
|
-
*/
|
1006
|
-
function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM;
|
1007
|
-
/** @deprecated since v10.0.0 use `createDecipheriv()` */
|
1008
|
-
function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM;
|
1009
|
-
/** @deprecated since v10.0.0 use `createDecipheriv()` */
|
1010
|
-
function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher;
|
1011
938
|
/**
|
1012
939
|
* Creates and returns a `Decipher` object that uses the given `algorithm`, `key` and initialization vector (`iv`).
|
1013
940
|
*
|
@@ -1070,7 +997,7 @@ declare module "crypto" {
|
|
1070
997
|
* * Using the `decipher.update()` and `decipher.final()` methods to
|
1071
998
|
* produce the unencrypted data.
|
1072
999
|
*
|
1073
|
-
* The {@link
|
1000
|
+
* The {@link createDecipheriv} method is
|
1074
1001
|
* used to create `Decipher` instances. `Decipher` objects are not to be created
|
1075
1002
|
* directly using the `new` keyword.
|
1076
1003
|
*
|
@@ -3406,7 +3333,7 @@ declare module "crypto" {
|
|
3406
3333
|
* @since v21.7.0, v20.12.0
|
3407
3334
|
* @param data When `data` is a string, it will be encoded as UTF-8 before being hashed. If a different input encoding is desired for a string input, user
|
3408
3335
|
* could encode the string into a `TypedArray` using either `TextEncoder` or `Buffer.from()` and passing the encoded `TypedArray` into this API instead.
|
3409
|
-
* @param [outputEncoding='hex'] [Encoding](https://nodejs.org/docs/latest-
|
3336
|
+
* @param [outputEncoding='hex'] [Encoding](https://nodejs.org/docs/latest-v22.x/api/buffer.html#buffers-and-character-encodings) used to encode the returned digest.
|
3410
3337
|
*/
|
3411
3338
|
function hash(algorithm: string, data: BinaryLike, outputEncoding?: BinaryToTextEncoding): string;
|
3412
3339
|
function hash(algorithm: string, data: BinaryLike, outputEncoding: "buffer"): Buffer;
|
@@ -23,7 +23,7 @@
|
|
23
23
|
* server.bind(41234);
|
24
24
|
* // Prints: server listening 0.0.0.0:41234
|
25
25
|
* ```
|
26
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
26
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/dgram.js)
|
27
27
|
*/
|
28
28
|
declare module "dgram" {
|
29
29
|
import { AddressInfo } from "node:net";
|
@@ -20,7 +20,7 @@
|
|
20
20
|
* should generally include the module name to avoid collisions with data from
|
21
21
|
* other modules.
|
22
22
|
* @since v15.1.0, v14.17.0
|
23
|
-
* @see [source](https://github.com/nodejs/node/blob/
|
23
|
+
* @see [source](https://github.com/nodejs/node/blob/v22.x/lib/diagnostics_channel.js)
|
24
24
|
*/
|
25
25
|
declare module "diagnostics_channel" {
|
26
26
|
import { AsyncLocalStorage } from "node:async_hooks";
|
@@ -346,20 +346,20 @@ declare module "dns/promises" {
|
|
346
346
|
*/
|
347
347
|
function setServers(servers: readonly string[]): void;
|
348
348
|
/**
|
349
|
-
* Set the default value of `
|
349
|
+
* Set the default value of `verbatim` in {@link lookup} and [`dnsPromises.lookup()`](https://nodejs.org/docs/latest-v22.x/api/dns.html#dnspromiseslookuphostname-options).
|
350
|
+
* The value could be:
|
350
351
|
*
|
351
|
-
* * `ipv4first`: sets default `
|
352
|
-
* * `
|
353
|
-
* * `verbatim`: sets default `order` to `verbatim`.
|
352
|
+
* * `ipv4first`: sets default `verbatim` to `false`.
|
353
|
+
* * `verbatim`: sets default `verbatim` to `true`.
|
354
354
|
*
|
355
|
-
* The default is `verbatim` and
|
356
|
-
*
|
357
|
-
*
|
358
|
-
*
|
355
|
+
* The default is `verbatim` and {@link setDefaultResultOrder} have higher
|
356
|
+
* priority than [`--dns-result-order`](https://nodejs.org/docs/latest-v22.x/api/cli.html#--dns-result-orderorder). When using
|
357
|
+
* [worker threads](https://nodejs.org/docs/latest-v22.x/api/worker_threads.html), {@link setDefaultResultOrder} from the main
|
358
|
+
* thread won't affect the default dns orders in workers.
|
359
359
|
* @since v16.4.0, v14.18.0
|
360
|
-
* @param order must be `'ipv4first'
|
360
|
+
* @param order must be `'ipv4first'` or `'verbatim'`.
|
361
361
|
*/
|
362
|
-
function setDefaultResultOrder(order: "ipv4first" | "
|
362
|
+
function setDefaultResultOrder(order: "ipv4first" | "verbatim"): void;
|
363
363
|
// Error codes
|
364
364
|
const NODATA: "ENODATA";
|
365
365
|
const FORMERR: "EFORMERR";
|