@types/node 16.18.74 → 16.18.76

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 v16.18/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/v16.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Sun, 21 Jan 2024 18:07:28 GMT
11
+ * Last updated: Fri, 26 Jan 2024 04:36:02 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
node v16.18/fs.d.ts CHANGED
@@ -289,31 +289,51 @@ declare module "fs" {
289
289
  * @since v0.5.8
290
290
  */
291
291
  close(): void;
292
+ /**
293
+ * 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
294
+ * no effect.
295
+ *
296
+ * By default, all `fs.FSWatcher` objects are "ref'ed", making it normally
297
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
298
+ * called previously.
299
+ * @since v14.3.0, v12.20.0
300
+ */
301
+ ref(): this;
302
+ /**
303
+ * When called, the active `fs.FSWatcher` object will not require the Node.js
304
+ * event loop to remain active. If there is no other activity keeping the
305
+ * event loop running, the process may exit before the `fs.FSWatcher` object's
306
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
307
+ * no effect.
308
+ * @since v14.3.0, v12.20.0
309
+ */
310
+ unref(): this;
292
311
  /**
293
312
  * events.EventEmitter
294
313
  * 1. change
295
- * 2. error
314
+ * 2. close
315
+ * 3. error
296
316
  */
297
317
  addListener(event: string, listener: (...args: any[]) => void): this;
298
318
  addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
299
- addListener(event: "error", listener: (error: Error) => void): this;
300
319
  addListener(event: "close", listener: () => void): this;
320
+ addListener(event: "error", listener: (error: Error) => void): this;
301
321
  on(event: string, listener: (...args: any[]) => void): this;
302
322
  on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
303
- on(event: "error", listener: (error: Error) => void): this;
304
323
  on(event: "close", listener: () => void): this;
324
+ on(event: "error", listener: (error: Error) => void): this;
305
325
  once(event: string, listener: (...args: any[]) => void): this;
306
326
  once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
307
- once(event: "error", listener: (error: Error) => void): this;
308
327
  once(event: "close", listener: () => void): this;
328
+ once(event: "error", listener: (error: Error) => void): this;
309
329
  prependListener(event: string, listener: (...args: any[]) => void): this;
310
330
  prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
311
- prependListener(event: "error", listener: (error: Error) => void): this;
312
331
  prependListener(event: "close", listener: () => void): this;
332
+ prependListener(event: "error", listener: (error: Error) => void): this;
313
333
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
314
334
  prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
315
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
316
335
  prependOnceListener(event: "close", listener: () => void): this;
336
+ prependOnceListener(event: "error", listener: (error: Error) => void): this;
317
337
  }
318
338
  /**
319
339
  * 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": "16.18.74",
3
+ "version": "16.18.76",
4
4
  "description": "TypeScript definitions for node",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -222,7 +222,7 @@
222
222
  },
223
223
  "scripts": {},
224
224
  "dependencies": {},
225
- "typesPublisherContentHash": "5d5bf0bf679e764cc23ccbb071bab84a55159b899be0fd674e4a0818c8e2ba42",
225
+ "typesPublisherContentHash": "05b8618c435d96ef511d4c4b5b3c7c45331f6b753e07fb40eb9d3b1503cf1b8d",
226
226
  "typeScriptVersion": "4.6",
227
227
  "nonNpm": true
228
228
  }
@@ -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/v16.9.0/lib/string_decoder.js)
39
+ * @see [source](https://github.com/nodejs/node/blob/v16.20.2/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: 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
@@ -59,7 +59,7 @@ declare module "string_decoder" {
59
59
  * @since v0.9.3
60
60
  * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
61
61
  */
62
- end(buffer?: Buffer): string;
62
+ end(buffer?: Buffer | NodeJS.ArrayBufferView): string;
63
63
  }
64
64
  }
65
65
  declare module "node:string_decoder" {
@@ -289,31 +289,51 @@ declare module "fs" {
289
289
  * @since v0.5.8
290
290
  */
291
291
  close(): void;
292
+ /**
293
+ * 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
294
+ * no effect.
295
+ *
296
+ * By default, all `fs.FSWatcher` objects are "ref'ed", making it normally
297
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
298
+ * called previously.
299
+ * @since v14.3.0, v12.20.0
300
+ */
301
+ ref(): this;
302
+ /**
303
+ * When called, the active `fs.FSWatcher` object will not require the Node.js
304
+ * event loop to remain active. If there is no other activity keeping the
305
+ * event loop running, the process may exit before the `fs.FSWatcher` object's
306
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
307
+ * no effect.
308
+ * @since v14.3.0, v12.20.0
309
+ */
310
+ unref(): this;
292
311
  /**
293
312
  * events.EventEmitter
294
313
  * 1. change
295
- * 2. error
314
+ * 2. close
315
+ * 3. error
296
316
  */
297
317
  addListener(event: string, listener: (...args: any[]) => void): this;
298
318
  addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
299
- addListener(event: "error", listener: (error: Error) => void): this;
300
319
  addListener(event: "close", listener: () => void): this;
320
+ addListener(event: "error", listener: (error: Error) => void): this;
301
321
  on(event: string, listener: (...args: any[]) => void): this;
302
322
  on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
303
- on(event: "error", listener: (error: Error) => void): this;
304
323
  on(event: "close", listener: () => void): this;
324
+ on(event: "error", listener: (error: Error) => void): this;
305
325
  once(event: string, listener: (...args: any[]) => void): this;
306
326
  once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
307
- once(event: "error", listener: (error: Error) => void): this;
308
327
  once(event: "close", listener: () => void): this;
328
+ once(event: "error", listener: (error: Error) => void): this;
309
329
  prependListener(event: string, listener: (...args: any[]) => void): this;
310
330
  prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
311
- prependListener(event: "error", listener: (error: Error) => void): this;
312
331
  prependListener(event: "close", listener: () => void): this;
332
+ prependListener(event: "error", listener: (error: Error) => void): this;
313
333
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
314
334
  prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
315
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
316
335
  prependOnceListener(event: "close", listener: () => void): this;
336
+ prependOnceListener(event: "error", listener: (error: Error) => void): this;
317
337
  }
318
338
  /**
319
339
  * 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/v16.9.0/lib/string_decoder.js)
39
+ * @see [source](https://github.com/nodejs/node/blob/v16.20.2/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: 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
@@ -59,7 +59,7 @@ declare module "string_decoder" {
59
59
  * @since v0.9.3
60
60
  * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
61
61
  */
62
- end(buffer?: Buffer): string;
62
+ end(buffer?: Buffer | NodeJS.ArrayBufferView): string;
63
63
  }
64
64
  }
65
65
  declare module "node:string_decoder" {