@types/node 18.7.23 → 18.8.0

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.
Files changed (5) hide show
  1. node/README.md +1 -1
  2. node/index.d.ts +1 -1
  3. node/net.d.ts +33 -2
  4. node/package.json +2 -2
  5. node/ts4.8/net.d.ts +33 -2
node/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 26 Sep 2022 19:33:03 GMT
11
+ * Last updated: Sun, 02 Oct 2022 19:33:03 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
14
14
 
node/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for non-npm package Node.js 18.7
1
+ // Type definitions for non-npm package Node.js 18.8
2
2
  // Project: https://nodejs.org/
3
3
  // Definitions by: Microsoft TypeScript <https://github.com/Microsoft>
4
4
  // DefinitelyTyped <https://github.com/DefinitelyTyped>
node/net.d.ts CHANGED
@@ -131,6 +131,17 @@ declare module 'net' {
131
131
  * @return The socket itself.
132
132
  */
133
133
  pause(): this;
134
+ /**
135
+ * Close the TCP connection by sending an RST packet and destroy the stream.
136
+ * If this TCP socket is in connecting status, it will send an RST packet
137
+ * and destroy this TCP socket once it is connected. Otherwise, it will call
138
+ * `socket.destroy` with an `ERR_SOCKET_CLOSED` Error. If this is not a TCP socket
139
+ * (for example, a pipe), calling this method will immediately throw
140
+ * an `ERR_INVALID_HANDLE_TYPE` Error.
141
+ * @since v18.3.0
142
+ * @return The socket itself.
143
+ */
144
+ resetAndDestroy(): this;
134
145
  /**
135
146
  * Resumes reading after a call to `socket.pause()`.
136
147
  * @return The socket itself.
@@ -266,6 +277,11 @@ declare module 'net' {
266
277
  * @since v0.9.6
267
278
  */
268
279
  readonly localPort?: number;
280
+ /**
281
+ * The string representation of the local IP family. `'IPv4'` or `'IPv6'`.
282
+ * @since v18.8.0
283
+ */
284
+ readonly localFamily?: string;
269
285
  /**
270
286
  * This property represents the state of the connection as a string.
271
287
  * @see {https://nodejs.org/api/net.html#socketreadystate}
@@ -315,7 +331,8 @@ declare module 'net' {
315
331
  * 5. end
316
332
  * 6. error
317
333
  * 7. lookup
318
- * 8. timeout
334
+ * 8. ready
335
+ * 9. timeout
319
336
  */
320
337
  addListener(event: string, listener: (...args: any[]) => void): this;
321
338
  addListener(event: 'close', listener: (hadError: boolean) => void): this;
@@ -422,6 +439,14 @@ declare module 'net' {
422
439
  */
423
440
  keepAliveInitialDelay?: number | undefined;
424
441
  }
442
+ interface DropArgument {
443
+ localAddress?: string;
444
+ localPort?: number;
445
+ localFamily?: string;
446
+ remoteAddress?: string;
447
+ remotePort?: number;
448
+ remoteFamily?: string;
449
+ }
425
450
  /**
426
451
  * This class is used to create a TCP or `IPC` server.
427
452
  * @since v0.1.90
@@ -558,37 +583,44 @@ declare module 'net' {
558
583
  * 2. connection
559
584
  * 3. error
560
585
  * 4. listening
586
+ * 5. drop
561
587
  */
562
588
  addListener(event: string, listener: (...args: any[]) => void): this;
563
589
  addListener(event: 'close', listener: () => void): this;
564
590
  addListener(event: 'connection', listener: (socket: Socket) => void): this;
565
591
  addListener(event: 'error', listener: (err: Error) => void): this;
566
592
  addListener(event: 'listening', listener: () => void): this;
593
+ addListener(event: 'drop', listener: (data?: DropArgument) => void): this;
567
594
  emit(event: string | symbol, ...args: any[]): boolean;
568
595
  emit(event: 'close'): boolean;
569
596
  emit(event: 'connection', socket: Socket): boolean;
570
597
  emit(event: 'error', err: Error): boolean;
571
598
  emit(event: 'listening'): boolean;
599
+ emit(event: 'drop', data?: DropArgument): boolean;
572
600
  on(event: string, listener: (...args: any[]) => void): this;
573
601
  on(event: 'close', listener: () => void): this;
574
602
  on(event: 'connection', listener: (socket: Socket) => void): this;
575
603
  on(event: 'error', listener: (err: Error) => void): this;
576
604
  on(event: 'listening', listener: () => void): this;
605
+ on(event: 'drop', listener: (data?: DropArgument) => void): this;
577
606
  once(event: string, listener: (...args: any[]) => void): this;
578
607
  once(event: 'close', listener: () => void): this;
579
608
  once(event: 'connection', listener: (socket: Socket) => void): this;
580
609
  once(event: 'error', listener: (err: Error) => void): this;
581
610
  once(event: 'listening', listener: () => void): this;
611
+ once(event: 'drop', listener: (data?: DropArgument) => void): this;
582
612
  prependListener(event: string, listener: (...args: any[]) => void): this;
583
613
  prependListener(event: 'close', listener: () => void): this;
584
614
  prependListener(event: 'connection', listener: (socket: Socket) => void): this;
585
615
  prependListener(event: 'error', listener: (err: Error) => void): this;
586
616
  prependListener(event: 'listening', listener: () => void): this;
617
+ prependListener(event: 'drop', listener: (data?: DropArgument) => void): this;
587
618
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
588
619
  prependOnceListener(event: 'close', listener: () => void): this;
589
620
  prependOnceListener(event: 'connection', listener: (socket: Socket) => void): this;
590
621
  prependOnceListener(event: 'error', listener: (err: Error) => void): this;
591
622
  prependOnceListener(event: 'listening', listener: () => void): this;
623
+ prependOnceListener(event: 'drop', listener: (data?: DropArgument) => void): this;
592
624
  }
593
625
  type IPVersion = 'ipv4' | 'ipv6';
594
626
  /**
@@ -814,7 +846,6 @@ declare module 'net' {
814
846
  class SocketAddress {
815
847
  constructor(options: SocketAddressInitOptions);
816
848
  /**
817
- * Either \`'ipv4'\` or \`'ipv6'\`.
818
849
  * @since v15.14.0, v14.18.0
819
850
  */
820
851
  readonly address: string;
node/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "18.7.23",
3
+ "version": "18.8.0",
4
4
  "description": "TypeScript definitions for Node.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -227,6 +227,6 @@
227
227
  },
228
228
  "scripts": {},
229
229
  "dependencies": {},
230
- "typesPublisherContentHash": "24d6e2b547c899309701e1e64ad11f0255c46a6f27da723607d3d1505e43d8da",
230
+ "typesPublisherContentHash": "54f0b73dedc6d751a0945c330043a807365cb735a3530635a46ca3432f8b140e",
231
231
  "typeScriptVersion": "4.1"
232
232
  }
node/ts4.8/net.d.ts CHANGED
@@ -131,6 +131,17 @@ declare module 'net' {
131
131
  * @return The socket itself.
132
132
  */
133
133
  pause(): this;
134
+ /**
135
+ * Close the TCP connection by sending an RST packet and destroy the stream.
136
+ * If this TCP socket is in connecting status, it will send an RST packet
137
+ * and destroy this TCP socket once it is connected. Otherwise, it will call
138
+ * `socket.destroy` with an `ERR_SOCKET_CLOSED` Error. If this is not a TCP socket
139
+ * (for example, a pipe), calling this method will immediately throw
140
+ * an `ERR_INVALID_HANDLE_TYPE` Error.
141
+ * @since v18.3.0
142
+ * @return The socket itself.
143
+ */
144
+ resetAndDestroy(): this;
134
145
  /**
135
146
  * Resumes reading after a call to `socket.pause()`.
136
147
  * @return The socket itself.
@@ -266,6 +277,11 @@ declare module 'net' {
266
277
  * @since v0.9.6
267
278
  */
268
279
  readonly localPort?: number;
280
+ /**
281
+ * The string representation of the local IP family. `'IPv4'` or `'IPv6'`.
282
+ * @since v18.8.0
283
+ */
284
+ readonly localFamily?: string;
269
285
  /**
270
286
  * This property represents the state of the connection as a string.
271
287
  * @see {https://nodejs.org/api/net.html#socketreadystate}
@@ -315,7 +331,8 @@ declare module 'net' {
315
331
  * 5. end
316
332
  * 6. error
317
333
  * 7. lookup
318
- * 8. timeout
334
+ * 8. ready
335
+ * 9. timeout
319
336
  */
320
337
  addListener(event: string, listener: (...args: any[]) => void): this;
321
338
  addListener(event: 'close', listener: (hadError: boolean) => void): this;
@@ -422,6 +439,14 @@ declare module 'net' {
422
439
  */
423
440
  keepAliveInitialDelay?: number | undefined;
424
441
  }
442
+ interface DropArgument {
443
+ localAddress?: string;
444
+ localPort?: number;
445
+ localFamily?: string;
446
+ remoteAddress?: string;
447
+ remotePort?: number;
448
+ remoteFamily?: string;
449
+ }
425
450
  /**
426
451
  * This class is used to create a TCP or `IPC` server.
427
452
  * @since v0.1.90
@@ -558,37 +583,44 @@ declare module 'net' {
558
583
  * 2. connection
559
584
  * 3. error
560
585
  * 4. listening
586
+ * 5. drop
561
587
  */
562
588
  addListener(event: string, listener: (...args: any[]) => void): this;
563
589
  addListener(event: 'close', listener: () => void): this;
564
590
  addListener(event: 'connection', listener: (socket: Socket) => void): this;
565
591
  addListener(event: 'error', listener: (err: Error) => void): this;
566
592
  addListener(event: 'listening', listener: () => void): this;
593
+ addListener(event: 'drop', listener: (data?: DropArgument) => void): this;
567
594
  emit(event: string | symbol, ...args: any[]): boolean;
568
595
  emit(event: 'close'): boolean;
569
596
  emit(event: 'connection', socket: Socket): boolean;
570
597
  emit(event: 'error', err: Error): boolean;
571
598
  emit(event: 'listening'): boolean;
599
+ emit(event: 'drop', data?: DropArgument): boolean;
572
600
  on(event: string, listener: (...args: any[]) => void): this;
573
601
  on(event: 'close', listener: () => void): this;
574
602
  on(event: 'connection', listener: (socket: Socket) => void): this;
575
603
  on(event: 'error', listener: (err: Error) => void): this;
576
604
  on(event: 'listening', listener: () => void): this;
605
+ on(event: 'drop', listener: (data?: DropArgument) => void): this;
577
606
  once(event: string, listener: (...args: any[]) => void): this;
578
607
  once(event: 'close', listener: () => void): this;
579
608
  once(event: 'connection', listener: (socket: Socket) => void): this;
580
609
  once(event: 'error', listener: (err: Error) => void): this;
581
610
  once(event: 'listening', listener: () => void): this;
611
+ once(event: 'drop', listener: (data?: DropArgument) => void): this;
582
612
  prependListener(event: string, listener: (...args: any[]) => void): this;
583
613
  prependListener(event: 'close', listener: () => void): this;
584
614
  prependListener(event: 'connection', listener: (socket: Socket) => void): this;
585
615
  prependListener(event: 'error', listener: (err: Error) => void): this;
586
616
  prependListener(event: 'listening', listener: () => void): this;
617
+ prependListener(event: 'drop', listener: (data?: DropArgument) => void): this;
587
618
  prependOnceListener(event: string, listener: (...args: any[]) => void): this;
588
619
  prependOnceListener(event: 'close', listener: () => void): this;
589
620
  prependOnceListener(event: 'connection', listener: (socket: Socket) => void): this;
590
621
  prependOnceListener(event: 'error', listener: (err: Error) => void): this;
591
622
  prependOnceListener(event: 'listening', listener: () => void): this;
623
+ prependOnceListener(event: 'drop', listener: (data?: DropArgument) => void): this;
592
624
  }
593
625
  type IPVersion = 'ipv4' | 'ipv6';
594
626
  /**
@@ -814,7 +846,6 @@ declare module 'net' {
814
846
  class SocketAddress {
815
847
  constructor(options: SocketAddressInitOptions);
816
848
  /**
817
- * Either \`'ipv4'\` or \`'ipv6'\`.
818
849
  * @since v15.14.0, v14.18.0
819
850
  */
820
851
  readonly address: string;