@types/node 18.19.8 → 18.19.10

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 v18.19/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v18.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Wed, 17 Jan 2024 06:36:16 GMT
11
+ * Last updated: Fri, 26 Jan 2024 04:36:02 GMT
12
12
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
13
13
 
14
14
  # Credits
node v18.19/fs.d.ts CHANGED
@@ -334,31 +334,51 @@ declare module "fs" {
334
334
  * @since v0.5.8
335
335
  */
336
336
  close(): void;
337
+ /**
338
+ * When called, requests that the Node.js event loop _not_ exit so long as the `fs.FSWatcher` is active. Calling `watcher.ref()` multiple times will have
339
+ * no effect.
340
+ *
341
+ * By default, all `fs.FSWatcher` objects are "ref'ed", making it normally
342
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
343
+ * called previously.
344
+ * @since v14.3.0, v12.20.0
345
+ */
346
+ ref(): this;
347
+ /**
348
+ * When called, the active `fs.FSWatcher` object will not require the Node.js
349
+ * event loop to remain active. If there is no other activity keeping the
350
+ * event loop running, the process may exit before the `fs.FSWatcher` object's
351
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
352
+ * no effect.
353
+ * @since v14.3.0, v12.20.0
354
+ */
355
+ unref(): this;
337
356
  /**
338
357
  * events.EventEmitter
339
358
  * 1. change
340
- * 2. error
359
+ * 2. close
360
+ * 3. error
341
361
  */
342
362
  addListener(event: string, listener: (...args: any[]) => void): this;
343
363
  addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
344
- addListener(event: "error", listener: (error: Error) => void): this;
345
364
  addListener(event: "close", listener: () => void): this;
365
+ addListener(event: "error", listener: (error: Error) => void): this;
346
366
  on(event: string, listener: (...args: any[]) => void): this;
347
367
  on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
348
- on(event: "error", listener: (error: Error) => void): this;
349
368
  on(event: "close", listener: () => void): this;
369
+ on(event: "error", listener: (error: Error) => void): this;
350
370
  once(event: string, listener: (...args: any[]) => void): this;
351
371
  once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
352
- once(event: "error", listener: (error: Error) => void): this;
353
372
  once(event: "close", listener: () => void): this;
373
+ once(event: "error", listener: (error: Error) => void): this;
354
374
  prependListener(event: string, listener: (...args: any[]) => void): this;
355
375
  prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
356
- prependListener(event: "error", listener: (error: Error) => void): this;
357
376
  prependListener(event: "close", listener: () => void): this;
377
+ prependListener(event: "error", listener: (error: Error) => void): this;
358
378
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
359
379
  prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
360
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
361
380
  prependOnceListener(event: "close", listener: () => void): this;
381
+ prependOnceListener(event: "error", listener: (error: Error) => void): this;
362
382
  }
363
383
  /**
364
384
  * Instances of `fs.ReadStream` are created and returned using the {@link createReadStream} function.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "18.19.8",
3
+ "version": "18.19.10",
4
4
  "description": "TypeScript definitions for node",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -229,7 +229,7 @@
229
229
  "dependencies": {
230
230
  "undici-types": "~5.26.4"
231
231
  },
232
- "typesPublisherContentHash": "c6ffdf1446429345b2047cbbd1128ef89768281b14f4584d14b4b11b4af8d008",
232
+ "typesPublisherContentHash": "c06efc5f7d8fde93e7c6141f0d3ff1b40956eb034747f7d979d81fb03b95a37b",
233
233
  "typeScriptVersion": "4.6",
234
234
  "nonNpm": true
235
235
  }
@@ -1,23 +1,23 @@
1
1
  /**
2
- * The `string_decoder` module provides an API for decoding `Buffer` objects into
3
- * strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
2
+ * The `node:string_decoder` module provides an API for decoding `Buffer` objects
3
+ * into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
4
4
  * characters. It can be accessed using:
5
5
  *
6
6
  * ```js
7
- * const { StringDecoder } = require('string_decoder');
7
+ * const { StringDecoder } = require('node:string_decoder');
8
8
  * ```
9
9
  *
10
10
  * The following example shows the basic use of the `StringDecoder` class.
11
11
  *
12
12
  * ```js
13
- * const { StringDecoder } = require('string_decoder');
13
+ * const { StringDecoder } = require('node:string_decoder');
14
14
  * const decoder = new StringDecoder('utf8');
15
15
  *
16
16
  * const cent = Buffer.from([0xC2, 0xA2]);
17
- * console.log(decoder.write(cent));
17
+ * console.log(decoder.write(cent)); // Prints: ¢
18
18
  *
19
19
  * const euro = Buffer.from([0xE2, 0x82, 0xAC]);
20
- * console.log(decoder.write(euro));
20
+ * console.log(decoder.write(euro)); // Prints: €
21
21
  * ```
22
22
  *
23
23
  * When a `Buffer` instance is written to the `StringDecoder` instance, an
@@ -29,14 +29,14 @@
29
29
  * symbol (`€`) are written over three separate operations:
30
30
  *
31
31
  * ```js
32
- * const { StringDecoder } = require('string_decoder');
32
+ * const { StringDecoder } = require('node:string_decoder');
33
33
  * const decoder = new StringDecoder('utf8');
34
34
  *
35
35
  * decoder.write(Buffer.from([0xE2]));
36
36
  * decoder.write(Buffer.from([0x82]));
37
- * console.log(decoder.end(Buffer.from([0xAC])));
37
+ * console.log(decoder.end(Buffer.from([0xAC]))); // Prints: €
38
38
  * ```
39
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/string_decoder.js)
39
+ * @see [source](https://github.com/nodejs/node/blob/v18.19.0/lib/string_decoder.js)
40
40
  */
41
41
  declare module "string_decoder" {
42
42
  class StringDecoder {
@@ -46,9 +46,9 @@ declare module "string_decoder" {
46
46
  * the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the
47
47
  * returned string and stored in an internal buffer for the next call to`stringDecoder.write()` or `stringDecoder.end()`.
48
48
  * @since v0.1.99
49
- * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
49
+ * @param buffer The bytes to decode.
50
50
  */
51
- write(buffer: Buffer): string;
51
+ write(buffer: string | Buffer | NodeJS.ArrayBufferView): string;
52
52
  /**
53
53
  * Returns any remaining input stored in the internal buffer as a string. Bytes
54
54
  * representing incomplete UTF-8 and UTF-16 characters will be replaced with
@@ -57,9 +57,9 @@ declare module "string_decoder" {
57
57
  * If the `buffer` argument is provided, one final call to `stringDecoder.write()`is performed before returning the remaining input.
58
58
  * After `end()` is called, the `stringDecoder` object can be reused for new input.
59
59
  * @since v0.9.3
60
- * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
60
+ * @param buffer The bytes to decode.
61
61
  */
62
- end(buffer?: Buffer): string;
62
+ end(buffer?: string | Buffer | NodeJS.ArrayBufferView): string;
63
63
  }
64
64
  }
65
65
  declare module "node:string_decoder" {
@@ -334,31 +334,51 @@ declare module "fs" {
334
334
  * @since v0.5.8
335
335
  */
336
336
  close(): void;
337
+ /**
338
+ * When called, requests that the Node.js event loop _not_ exit so long as the `fs.FSWatcher` is active. Calling `watcher.ref()` multiple times will have
339
+ * no effect.
340
+ *
341
+ * By default, all `fs.FSWatcher` objects are "ref'ed", making it normally
342
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
343
+ * called previously.
344
+ * @since v14.3.0, v12.20.0
345
+ */
346
+ ref(): this;
347
+ /**
348
+ * When called, the active `fs.FSWatcher` object will not require the Node.js
349
+ * event loop to remain active. If there is no other activity keeping the
350
+ * event loop running, the process may exit before the `fs.FSWatcher` object's
351
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
352
+ * no effect.
353
+ * @since v14.3.0, v12.20.0
354
+ */
355
+ unref(): this;
337
356
  /**
338
357
  * events.EventEmitter
339
358
  * 1. change
340
- * 2. error
359
+ * 2. close
360
+ * 3. error
341
361
  */
342
362
  addListener(event: string, listener: (...args: any[]) => void): this;
343
363
  addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
344
- addListener(event: "error", listener: (error: Error) => void): this;
345
364
  addListener(event: "close", listener: () => void): this;
365
+ addListener(event: "error", listener: (error: Error) => void): this;
346
366
  on(event: string, listener: (...args: any[]) => void): this;
347
367
  on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
348
- on(event: "error", listener: (error: Error) => void): this;
349
368
  on(event: "close", listener: () => void): this;
369
+ on(event: "error", listener: (error: Error) => void): this;
350
370
  once(event: string, listener: (...args: any[]) => void): this;
351
371
  once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
352
- once(event: "error", listener: (error: Error) => void): this;
353
372
  once(event: "close", listener: () => void): this;
373
+ once(event: "error", listener: (error: Error) => void): this;
354
374
  prependListener(event: string, listener: (...args: any[]) => void): this;
355
375
  prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
356
- prependListener(event: "error", listener: (error: Error) => void): this;
357
376
  prependListener(event: "close", listener: () => void): this;
377
+ prependListener(event: "error", listener: (error: Error) => void): this;
358
378
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
359
379
  prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
360
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
361
380
  prependOnceListener(event: "close", listener: () => void): this;
381
+ prependOnceListener(event: "error", listener: (error: Error) => void): this;
362
382
  }
363
383
  /**
364
384
  * Instances of `fs.ReadStream` are created and returned using the {@link createReadStream} function.
@@ -1,23 +1,23 @@
1
1
  /**
2
- * The `string_decoder` module provides an API for decoding `Buffer` objects into
3
- * strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
2
+ * The `node:string_decoder` module provides an API for decoding `Buffer` objects
3
+ * into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
4
4
  * characters. It can be accessed using:
5
5
  *
6
6
  * ```js
7
- * const { StringDecoder } = require('string_decoder');
7
+ * const { StringDecoder } = require('node:string_decoder');
8
8
  * ```
9
9
  *
10
10
  * The following example shows the basic use of the `StringDecoder` class.
11
11
  *
12
12
  * ```js
13
- * const { StringDecoder } = require('string_decoder');
13
+ * const { StringDecoder } = require('node:string_decoder');
14
14
  * const decoder = new StringDecoder('utf8');
15
15
  *
16
16
  * const cent = Buffer.from([0xC2, 0xA2]);
17
- * console.log(decoder.write(cent));
17
+ * console.log(decoder.write(cent)); // Prints: ¢
18
18
  *
19
19
  * const euro = Buffer.from([0xE2, 0x82, 0xAC]);
20
- * console.log(decoder.write(euro));
20
+ * console.log(decoder.write(euro)); // Prints: €
21
21
  * ```
22
22
  *
23
23
  * When a `Buffer` instance is written to the `StringDecoder` instance, an
@@ -29,14 +29,14 @@
29
29
  * symbol (`€`) are written over three separate operations:
30
30
  *
31
31
  * ```js
32
- * const { StringDecoder } = require('string_decoder');
32
+ * const { StringDecoder } = require('node:string_decoder');
33
33
  * const decoder = new StringDecoder('utf8');
34
34
  *
35
35
  * decoder.write(Buffer.from([0xE2]));
36
36
  * decoder.write(Buffer.from([0x82]));
37
- * console.log(decoder.end(Buffer.from([0xAC])));
37
+ * console.log(decoder.end(Buffer.from([0xAC]))); // Prints: €
38
38
  * ```
39
- * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/string_decoder.js)
39
+ * @see [source](https://github.com/nodejs/node/blob/v18.19.0/lib/string_decoder.js)
40
40
  */
41
41
  declare module "string_decoder" {
42
42
  class StringDecoder {
@@ -46,9 +46,9 @@ declare module "string_decoder" {
46
46
  * the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the
47
47
  * returned string and stored in an internal buffer for the next call to`stringDecoder.write()` or `stringDecoder.end()`.
48
48
  * @since v0.1.99
49
- * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
49
+ * @param buffer The bytes to decode.
50
50
  */
51
- write(buffer: Buffer): string;
51
+ write(buffer: string | Buffer | NodeJS.ArrayBufferView): string;
52
52
  /**
53
53
  * Returns any remaining input stored in the internal buffer as a string. Bytes
54
54
  * representing incomplete UTF-8 and UTF-16 characters will be replaced with
@@ -57,9 +57,9 @@ declare module "string_decoder" {
57
57
  * If the `buffer` argument is provided, one final call to `stringDecoder.write()`is performed before returning the remaining input.
58
58
  * After `end()` is called, the `stringDecoder` object can be reused for new input.
59
59
  * @since v0.9.3
60
- * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
60
+ * @param buffer The bytes to decode.
61
61
  */
62
- end(buffer?: Buffer): string;
62
+ end(buffer?: string | Buffer | NodeJS.ArrayBufferView): string;
63
63
  }
64
64
  }
65
65
  declare module "node:string_decoder" {