cdk-ecr-deployment 1.0.1 → 2.0.3

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 (139) hide show
  1. package/.gitattributes +2 -1
  2. package/.jsii +2685 -574
  3. package/API.md +8 -8
  4. package/README.md +2 -0
  5. package/lib/index.d.ts +2 -4
  6. package/lib/index.js +16 -18
  7. package/node_modules/@types/cacheable-request/node_modules/@types/node/README.md +1 -1
  8. package/node_modules/@types/cacheable-request/node_modules/@types/node/assert.d.ts +1 -1
  9. package/node_modules/@types/cacheable-request/node_modules/@types/node/async_hooks.d.ts +7 -3
  10. package/node_modules/@types/cacheable-request/node_modules/@types/node/buffer.d.ts +9 -9
  11. package/node_modules/@types/cacheable-request/node_modules/@types/node/child_process.d.ts +1 -1
  12. package/node_modules/@types/cacheable-request/node_modules/@types/node/cluster.d.ts +1 -1
  13. package/node_modules/@types/cacheable-request/node_modules/@types/node/console.d.ts +1 -1
  14. package/node_modules/@types/cacheable-request/node_modules/@types/node/crypto.d.ts +2 -2
  15. package/node_modules/@types/cacheable-request/node_modules/@types/node/dgram.d.ts +2 -2
  16. package/node_modules/@types/cacheable-request/node_modules/@types/node/diagnostics_channel.d.ts +1 -1
  17. package/node_modules/@types/cacheable-request/node_modules/@types/node/dns/promises.d.ts +12 -10
  18. package/node_modules/@types/cacheable-request/node_modules/@types/node/dns.d.ts +17 -12
  19. package/node_modules/@types/cacheable-request/node_modules/@types/node/domain.d.ts +1 -1
  20. package/node_modules/@types/cacheable-request/node_modules/@types/node/events.d.ts +2 -2
  21. package/node_modules/@types/cacheable-request/node_modules/@types/node/fs/promises.d.ts +5 -5
  22. package/node_modules/@types/cacheable-request/node_modules/@types/node/fs.d.ts +62 -11
  23. package/node_modules/@types/cacheable-request/node_modules/@types/node/http.d.ts +20 -3
  24. package/node_modules/@types/cacheable-request/node_modules/@types/node/http2.d.ts +2 -2
  25. package/node_modules/@types/cacheable-request/node_modules/@types/node/https.d.ts +1 -1
  26. package/node_modules/@types/cacheable-request/node_modules/@types/node/index.d.ts +1 -1
  27. package/node_modules/@types/cacheable-request/node_modules/@types/node/inspector.d.ts +4 -5
  28. package/node_modules/@types/cacheable-request/node_modules/@types/node/net.d.ts +11 -11
  29. package/node_modules/@types/cacheable-request/node_modules/@types/node/os.d.ts +1 -1
  30. package/node_modules/@types/cacheable-request/node_modules/@types/node/package.json +2 -2
  31. package/node_modules/@types/cacheable-request/node_modules/@types/node/path.d.ts +1 -1
  32. package/node_modules/@types/cacheable-request/node_modules/@types/node/perf_hooks.d.ts +4 -4
  33. package/node_modules/@types/cacheable-request/node_modules/@types/node/punycode.d.ts +1 -1
  34. package/node_modules/@types/cacheable-request/node_modules/@types/node/querystring.d.ts +1 -1
  35. package/node_modules/@types/cacheable-request/node_modules/@types/node/readline.d.ts +121 -14
  36. package/node_modules/@types/cacheable-request/node_modules/@types/node/repl.d.ts +1 -1
  37. package/node_modules/@types/cacheable-request/node_modules/@types/node/stream/web.d.ts +3 -65
  38. package/node_modules/@types/cacheable-request/node_modules/@types/node/stream.d.ts +2 -2
  39. package/node_modules/@types/cacheable-request/node_modules/@types/node/string_decoder.d.ts +1 -1
  40. package/node_modules/@types/cacheable-request/node_modules/@types/node/timers.d.ts +1 -1
  41. package/node_modules/@types/cacheable-request/node_modules/@types/node/tls.d.ts +1 -1
  42. package/node_modules/@types/cacheable-request/node_modules/@types/node/trace_events.d.ts +1 -1
  43. package/node_modules/@types/cacheable-request/node_modules/@types/node/tty.d.ts +1 -1
  44. package/node_modules/@types/cacheable-request/node_modules/@types/node/url.d.ts +58 -18
  45. package/node_modules/@types/cacheable-request/node_modules/@types/node/util.d.ts +3 -3
  46. package/node_modules/@types/cacheable-request/node_modules/@types/node/v8.d.ts +3 -3
  47. package/node_modules/@types/cacheable-request/node_modules/@types/node/vm.d.ts +1 -1
  48. package/node_modules/@types/cacheable-request/node_modules/@types/node/wasi.d.ts +1 -1
  49. package/node_modules/@types/cacheable-request/node_modules/@types/node/worker_threads.d.ts +4 -4
  50. package/node_modules/@types/cacheable-request/node_modules/@types/node/zlib.d.ts +1 -1
  51. package/node_modules/@types/keyv/node_modules/@types/node/README.md +1 -1
  52. package/node_modules/@types/keyv/node_modules/@types/node/assert.d.ts +1 -1
  53. package/node_modules/@types/keyv/node_modules/@types/node/async_hooks.d.ts +7 -3
  54. package/node_modules/@types/keyv/node_modules/@types/node/buffer.d.ts +9 -9
  55. package/node_modules/@types/keyv/node_modules/@types/node/child_process.d.ts +1 -1
  56. package/node_modules/@types/keyv/node_modules/@types/node/cluster.d.ts +1 -1
  57. package/node_modules/@types/keyv/node_modules/@types/node/console.d.ts +1 -1
  58. package/node_modules/@types/keyv/node_modules/@types/node/crypto.d.ts +2 -2
  59. package/node_modules/@types/keyv/node_modules/@types/node/dgram.d.ts +2 -2
  60. package/node_modules/@types/keyv/node_modules/@types/node/diagnostics_channel.d.ts +1 -1
  61. package/node_modules/@types/keyv/node_modules/@types/node/dns/promises.d.ts +12 -10
  62. package/node_modules/@types/keyv/node_modules/@types/node/dns.d.ts +17 -12
  63. package/node_modules/@types/keyv/node_modules/@types/node/domain.d.ts +1 -1
  64. package/node_modules/@types/keyv/node_modules/@types/node/events.d.ts +2 -2
  65. package/node_modules/@types/keyv/node_modules/@types/node/fs/promises.d.ts +5 -5
  66. package/node_modules/@types/keyv/node_modules/@types/node/fs.d.ts +62 -11
  67. package/node_modules/@types/keyv/node_modules/@types/node/http.d.ts +20 -3
  68. package/node_modules/@types/keyv/node_modules/@types/node/http2.d.ts +2 -2
  69. package/node_modules/@types/keyv/node_modules/@types/node/https.d.ts +1 -1
  70. package/node_modules/@types/keyv/node_modules/@types/node/index.d.ts +1 -1
  71. package/node_modules/@types/keyv/node_modules/@types/node/inspector.d.ts +4 -5
  72. package/node_modules/@types/keyv/node_modules/@types/node/net.d.ts +11 -11
  73. package/node_modules/@types/keyv/node_modules/@types/node/os.d.ts +1 -1
  74. package/node_modules/@types/keyv/node_modules/@types/node/package.json +2 -2
  75. package/node_modules/@types/keyv/node_modules/@types/node/path.d.ts +1 -1
  76. package/node_modules/@types/keyv/node_modules/@types/node/perf_hooks.d.ts +4 -4
  77. package/node_modules/@types/keyv/node_modules/@types/node/punycode.d.ts +1 -1
  78. package/node_modules/@types/keyv/node_modules/@types/node/querystring.d.ts +1 -1
  79. package/node_modules/@types/keyv/node_modules/@types/node/readline.d.ts +121 -14
  80. package/node_modules/@types/keyv/node_modules/@types/node/repl.d.ts +1 -1
  81. package/node_modules/@types/keyv/node_modules/@types/node/stream/web.d.ts +3 -65
  82. package/node_modules/@types/keyv/node_modules/@types/node/stream.d.ts +2 -2
  83. package/node_modules/@types/keyv/node_modules/@types/node/string_decoder.d.ts +1 -1
  84. package/node_modules/@types/keyv/node_modules/@types/node/timers.d.ts +1 -1
  85. package/node_modules/@types/keyv/node_modules/@types/node/tls.d.ts +1 -1
  86. package/node_modules/@types/keyv/node_modules/@types/node/trace_events.d.ts +1 -1
  87. package/node_modules/@types/keyv/node_modules/@types/node/tty.d.ts +1 -1
  88. package/node_modules/@types/keyv/node_modules/@types/node/url.d.ts +58 -18
  89. package/node_modules/@types/keyv/node_modules/@types/node/util.d.ts +3 -3
  90. package/node_modules/@types/keyv/node_modules/@types/node/v8.d.ts +3 -3
  91. package/node_modules/@types/keyv/node_modules/@types/node/vm.d.ts +1 -1
  92. package/node_modules/@types/keyv/node_modules/@types/node/wasi.d.ts +1 -1
  93. package/node_modules/@types/keyv/node_modules/@types/node/worker_threads.d.ts +4 -4
  94. package/node_modules/@types/keyv/node_modules/@types/node/zlib.d.ts +1 -1
  95. package/node_modules/@types/responselike/node_modules/@types/node/README.md +1 -1
  96. package/node_modules/@types/responselike/node_modules/@types/node/assert.d.ts +1 -1
  97. package/node_modules/@types/responselike/node_modules/@types/node/async_hooks.d.ts +7 -3
  98. package/node_modules/@types/responselike/node_modules/@types/node/buffer.d.ts +9 -9
  99. package/node_modules/@types/responselike/node_modules/@types/node/child_process.d.ts +1 -1
  100. package/node_modules/@types/responselike/node_modules/@types/node/cluster.d.ts +1 -1
  101. package/node_modules/@types/responselike/node_modules/@types/node/console.d.ts +1 -1
  102. package/node_modules/@types/responselike/node_modules/@types/node/crypto.d.ts +2 -2
  103. package/node_modules/@types/responselike/node_modules/@types/node/dgram.d.ts +2 -2
  104. package/node_modules/@types/responselike/node_modules/@types/node/diagnostics_channel.d.ts +1 -1
  105. package/node_modules/@types/responselike/node_modules/@types/node/dns/promises.d.ts +12 -10
  106. package/node_modules/@types/responselike/node_modules/@types/node/dns.d.ts +17 -12
  107. package/node_modules/@types/responselike/node_modules/@types/node/domain.d.ts +1 -1
  108. package/node_modules/@types/responselike/node_modules/@types/node/events.d.ts +2 -2
  109. package/node_modules/@types/responselike/node_modules/@types/node/fs/promises.d.ts +5 -5
  110. package/node_modules/@types/responselike/node_modules/@types/node/fs.d.ts +62 -11
  111. package/node_modules/@types/responselike/node_modules/@types/node/http.d.ts +20 -3
  112. package/node_modules/@types/responselike/node_modules/@types/node/http2.d.ts +2 -2
  113. package/node_modules/@types/responselike/node_modules/@types/node/https.d.ts +1 -1
  114. package/node_modules/@types/responselike/node_modules/@types/node/index.d.ts +1 -1
  115. package/node_modules/@types/responselike/node_modules/@types/node/inspector.d.ts +4 -5
  116. package/node_modules/@types/responselike/node_modules/@types/node/net.d.ts +11 -11
  117. package/node_modules/@types/responselike/node_modules/@types/node/os.d.ts +1 -1
  118. package/node_modules/@types/responselike/node_modules/@types/node/package.json +2 -2
  119. package/node_modules/@types/responselike/node_modules/@types/node/path.d.ts +1 -1
  120. package/node_modules/@types/responselike/node_modules/@types/node/perf_hooks.d.ts +4 -4
  121. package/node_modules/@types/responselike/node_modules/@types/node/punycode.d.ts +1 -1
  122. package/node_modules/@types/responselike/node_modules/@types/node/querystring.d.ts +1 -1
  123. package/node_modules/@types/responselike/node_modules/@types/node/readline.d.ts +121 -14
  124. package/node_modules/@types/responselike/node_modules/@types/node/repl.d.ts +1 -1
  125. package/node_modules/@types/responselike/node_modules/@types/node/stream/web.d.ts +3 -65
  126. package/node_modules/@types/responselike/node_modules/@types/node/stream.d.ts +2 -2
  127. package/node_modules/@types/responselike/node_modules/@types/node/string_decoder.d.ts +1 -1
  128. package/node_modules/@types/responselike/node_modules/@types/node/timers.d.ts +1 -1
  129. package/node_modules/@types/responselike/node_modules/@types/node/tls.d.ts +1 -1
  130. package/node_modules/@types/responselike/node_modules/@types/node/trace_events.d.ts +1 -1
  131. package/node_modules/@types/responselike/node_modules/@types/node/tty.d.ts +1 -1
  132. package/node_modules/@types/responselike/node_modules/@types/node/url.d.ts +58 -18
  133. package/node_modules/@types/responselike/node_modules/@types/node/util.d.ts +3 -3
  134. package/node_modules/@types/responselike/node_modules/@types/node/v8.d.ts +3 -3
  135. package/node_modules/@types/responselike/node_modules/@types/node/vm.d.ts +1 -1
  136. package/node_modules/@types/responselike/node_modules/@types/node/wasi.d.ts +1 -1
  137. package/node_modules/@types/responselike/node_modules/@types/node/worker_threads.d.ts +4 -4
  138. package/node_modules/@types/responselike/node_modules/@types/node/zlib.d.ts +1 -1
  139. package/package.json +14 -22
@@ -16,7 +16,7 @@
16
16
  *
17
17
  * All file system operations have synchronous, callback, and promise-based
18
18
  * forms, and are accessible using both CommonJS syntax and ES6 Modules (ESM).
19
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/fs.js)
19
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/fs.js)
20
20
  */
21
21
  declare module 'fs' {
22
22
  import * as stream from 'node:stream';
@@ -268,18 +268,22 @@ declare module 'fs' {
268
268
  */
269
269
  export interface StatWatcher extends EventEmitter {
270
270
  /**
271
+ * When called, requests that the Node.js event loop _not_ exit so long as the `fs.StatWatcher` is active. Calling `watcher.ref()` multiple times will have
272
+ * no effect.
273
+ *
274
+ * By default, all `fs.StatWatcher` objects are "ref'ed", making it normally
275
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
276
+ * called previously.
271
277
  * @since v14.3.0, v12.20.0
272
- * When called, requests that the Node.js event loop not exit so long as the `fs.StatWatcher` is active.
273
- * Calling `watcher.ref()` multiple times will have no effect.
274
- * By default, all `fs.StatWatcher`` objects are "ref'ed", making it normally unnecessary to call `watcher.ref()`
275
- * unless `watcher.unref()` had been called previously.
276
278
  */
277
279
  ref(): this;
278
280
  /**
281
+ * When called, the active `fs.StatWatcher` object will not require the Node.js
282
+ * event loop to remain active. If there is no other activity keeping the
283
+ * event loop running, the process may exit before the `fs.StatWatcher` object's
284
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
285
+ * no effect.
279
286
  * @since v14.3.0, v12.20.0
280
- * When called, the active `fs.StatWatcher`` object will not require the Node.js event loop to remain active.
281
- * If there is no other activity keeping the event loop running, the process may exit before the `fs.StatWatcher`` object's callback is invoked.
282
- * `Calling watcher.unref()` multiple times will have no effect.
283
287
  */
284
288
  unref(): this;
285
289
  }
@@ -1014,8 +1018,10 @@ declare module 'fs' {
1014
1018
  function __promisify__(fd: number, options?: StatOptions): Promise<Stats | BigIntStats>;
1015
1019
  }
1016
1020
  /**
1017
- * Synchronous fstat(2) - Get file status.
1018
- * @param fd A file descriptor.
1021
+ * Retrieves the `fs.Stats` for the file descriptor.
1022
+ *
1023
+ * See the POSIX [`fstat(2)`](http://man7.org/linux/man-pages/man2/fstat.2.html) documentation for more detail.
1024
+ * @since v0.1.95
1019
1025
  */
1020
1026
  export function fstatSync(
1021
1027
  fd: number,
@@ -1030,7 +1036,6 @@ declare module 'fs' {
1030
1036
  }
1031
1037
  ): BigIntStats;
1032
1038
  export function fstatSync(fd: number, options?: StatOptions): Stats | BigIntStats;
1033
-
1034
1039
  /**
1035
1040
  * Retrieves the `fs.Stats` for the symbolic link referred to by the path.
1036
1041
  * The callback gets two arguments `(err, stats)` where `stats` is a `fs.Stats` object. `lstat()` is identical to `stat()`, except that if `path` is a symbolic
@@ -2812,6 +2817,52 @@ declare module 'fs' {
2812
2817
  persistent?: boolean | undefined;
2813
2818
  interval?: number | undefined;
2814
2819
  }
2820
+ /**
2821
+ * Watch for changes on `filename`. The callback `listener` will be called each
2822
+ * time the file is accessed.
2823
+ *
2824
+ * The `options` argument may be omitted. If provided, it should be an object. The`options` object may contain a boolean named `persistent` that indicates
2825
+ * whether the process should continue to run as long as files are being watched.
2826
+ * The `options` object may specify an `interval` property indicating how often the
2827
+ * target should be polled in milliseconds.
2828
+ *
2829
+ * The `listener` gets two arguments the current stat object and the previous
2830
+ * stat object:
2831
+ *
2832
+ * ```js
2833
+ * import { watchFile } from 'fs';
2834
+ *
2835
+ * watchFile('message.text', (curr, prev) => {
2836
+ * console.log(`the current mtime is: ${curr.mtime}`);
2837
+ * console.log(`the previous mtime was: ${prev.mtime}`);
2838
+ * });
2839
+ * ```
2840
+ *
2841
+ * These stat objects are instances of `fs.Stat`. If the `bigint` option is `true`,
2842
+ * the numeric values in these objects are specified as `BigInt`s.
2843
+ *
2844
+ * To be notified when the file was modified, not just accessed, it is necessary
2845
+ * to compare `curr.mtimeMs` and `prev.mtimeMs`.
2846
+ *
2847
+ * When an `fs.watchFile` operation results in an `ENOENT` error, it
2848
+ * will invoke the listener once, with all the fields zeroed (or, for dates, the
2849
+ * Unix Epoch). If the file is created later on, the listener will be called
2850
+ * again, with the latest stat objects. This is a change in functionality since
2851
+ * v0.10.
2852
+ *
2853
+ * Using {@link watch} is more efficient than `fs.watchFile` and`fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and`fs.unwatchFile` when possible.
2854
+ *
2855
+ * When a file being watched by `fs.watchFile()` disappears and reappears,
2856
+ * then the contents of `previous` in the second callback event (the file's
2857
+ * reappearance) will be the same as the contents of `previous` in the first
2858
+ * callback event (its disappearance).
2859
+ *
2860
+ * This happens when:
2861
+ *
2862
+ * * the file is deleted, followed by a restore
2863
+ * * the file is renamed and then renamed a second time back to its original name
2864
+ * @since v0.1.31
2865
+ */
2815
2866
  export function watchFile(
2816
2867
  filename: PathLike,
2817
2868
  options:
@@ -37,7 +37,7 @@
37
37
  * 'Host', 'mysite.com',
38
38
  * 'accepT', '*' ]
39
39
  * ```
40
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/http.js)
40
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/http.js)
41
41
  */
42
42
  declare module 'http' {
43
43
  import * as stream from 'node:stream';
@@ -341,7 +341,7 @@ declare module 'http' {
341
341
  /**
342
342
  * Aliases of `outgoingMessage.socket`
343
343
  * @since v0.3.0
344
- * @deprecated Since v15.12.0 - Use `socket` instead.
344
+ * @deprecated Since v15.12.0,v14.17.1 - Use `socket` instead.
345
345
  */
346
346
  readonly connection: Socket | null;
347
347
  /**
@@ -608,6 +608,7 @@ declare module 'http' {
608
608
  * The `request.aborted` property will be `true` if the request has
609
609
  * been aborted.
610
610
  * @since v0.11.14
611
+ * @deprecated Since v17.0.0 - Check `destroyed` instead.
611
612
  */
612
613
  aborted: boolean;
613
614
  /**
@@ -667,9 +668,12 @@ declare module 'http' {
667
668
  * const headerNames = request.getRawHeaderNames();
668
669
  * // headerNames === ['Foo', 'Set-Cookie']
669
670
  * ```
670
- * @since v15.13.0
671
+ * @since v15.13.0, v14.17.0
671
672
  */
672
673
  getRawHeaderNames(): string[];
674
+ /**
675
+ * @deprecated
676
+ */
673
677
  addListener(event: 'abort', listener: () => void): this;
674
678
  addListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
675
679
  addListener(event: 'continue', listener: () => void): this;
@@ -685,6 +689,9 @@ declare module 'http' {
685
689
  addListener(event: 'pipe', listener: (src: stream.Readable) => void): this;
686
690
  addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this;
687
691
  addListener(event: string | symbol, listener: (...args: any[]) => void): this;
692
+ /**
693
+ * @deprecated
694
+ */
688
695
  on(event: 'abort', listener: () => void): this;
689
696
  on(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
690
697
  on(event: 'continue', listener: () => void): this;
@@ -700,6 +707,9 @@ declare module 'http' {
700
707
  on(event: 'pipe', listener: (src: stream.Readable) => void): this;
701
708
  on(event: 'unpipe', listener: (src: stream.Readable) => void): this;
702
709
  on(event: string | symbol, listener: (...args: any[]) => void): this;
710
+ /**
711
+ * @deprecated
712
+ */
703
713
  once(event: 'abort', listener: () => void): this;
704
714
  once(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
705
715
  once(event: 'continue', listener: () => void): this;
@@ -715,6 +725,9 @@ declare module 'http' {
715
725
  once(event: 'pipe', listener: (src: stream.Readable) => void): this;
716
726
  once(event: 'unpipe', listener: (src: stream.Readable) => void): this;
717
727
  once(event: string | symbol, listener: (...args: any[]) => void): this;
728
+ /**
729
+ * @deprecated
730
+ */
718
731
  prependListener(event: 'abort', listener: () => void): this;
719
732
  prependListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
720
733
  prependListener(event: 'continue', listener: () => void): this;
@@ -730,6 +743,9 @@ declare module 'http' {
730
743
  prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this;
731
744
  prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this;
732
745
  prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
746
+ /**
747
+ * @deprecated
748
+ */
733
749
  prependOnceListener(event: 'abort', listener: () => void): this;
734
750
  prependOnceListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
735
751
  prependOnceListener(event: 'continue', listener: () => void): this;
@@ -762,6 +778,7 @@ declare module 'http' {
762
778
  * The `message.aborted` property will be `true` if the request has
763
779
  * been aborted.
764
780
  * @since v10.1.0
781
+ * @deprecated Since v17.0.0 - Check `message.destroyed` from <a href="stream.html#class-streamreadable" class="type">stream.Readable</a>.
765
782
  */
766
783
  aborted: boolean;
767
784
  /**
@@ -6,7 +6,7 @@
6
6
  * const http2 = require('http2');
7
7
  * ```
8
8
  * @since v8.4.0
9
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/http2.js)
9
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/http2.js)
10
10
  */
11
11
  declare module 'http2' {
12
12
  import EventEmitter = require('node:events');
@@ -757,7 +757,7 @@ declare module 'http2' {
757
757
  * session.setLocalWindowSize(expectedWindowSize);
758
758
  * });
759
759
  * ```
760
- * @since v15.3.0
760
+ * @since v15.3.0, v14.18.0
761
761
  */
762
762
  setLocalWindowSize(windowSize: number): void;
763
763
  /**
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
3
3
  * separate module.
4
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/https.js)
4
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/https.js)
5
5
  */
6
6
  declare module 'https' {
7
7
  import { Duplex } from 'node:stream';
@@ -1,4 +1,4 @@
1
- // Type definitions for non-npm package Node.js 16.11
1
+ // Type definitions for non-npm package Node.js 17.0
2
2
  // Project: https://nodejs.org/
3
3
  // Definitions by: Microsoft TypeScript <https://github.com/Microsoft>
4
4
  // DefinitelyTyped <https://github.com/DefinitelyTyped>
@@ -15,7 +15,7 @@
15
15
  * ```js
16
16
  * const inspector = require('inspector');
17
17
  * ```
18
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/inspector.js)
18
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/inspector.js)
19
19
  */
20
20
  declare module 'inspector' {
21
21
  import EventEmitter = require('node:events');
@@ -1779,10 +1779,9 @@ declare module 'inspector' {
1779
1779
  */
1780
1780
  connect(): void;
1781
1781
  /**
1782
- * Connects a session to the main thread inspector back-end.
1783
- * An exception will be thrown if this API was not called on a Worker
1784
- * thread.
1785
- * @since 12.11.0
1782
+ * Connects a session to the main thread inspector back-end. An exception will
1783
+ * be thrown if this API was not called on a Worker thread.
1784
+ * @since v12.11.0
1786
1785
  */
1787
1786
  connectToMainThread(): void;
1788
1787
  /**
@@ -10,7 +10,7 @@
10
10
  * ```js
11
11
  * const net = require('net');
12
12
  * ```
13
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/net.js)
13
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/net.js)
14
14
  */
15
15
  declare module 'net' {
16
16
  import * as stream from 'node:stream';
@@ -560,12 +560,12 @@ declare module 'net' {
560
560
  * The `BlockList` object can be used with some network APIs to specify rules for
561
561
  * disabling inbound or outbound access to specific IP addresses, IP ranges, or
562
562
  * IP subnets.
563
- * @since v15.0.0
563
+ * @since v15.0.0, v14.18.0
564
564
  */
565
565
  class BlockList {
566
566
  /**
567
567
  * Adds a rule to block the given IP address.
568
- * @since v15.0.0
568
+ * @since v15.0.0, v14.18.0
569
569
  * @param address An IPv4 or IPv6 address.
570
570
  * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
571
571
  */
@@ -573,7 +573,7 @@ declare module 'net' {
573
573
  addAddress(address: SocketAddress): void;
574
574
  /**
575
575
  * Adds a rule to block a range of IP addresses from `start` (inclusive) to`end` (inclusive).
576
- * @since v15.0.0
576
+ * @since v15.0.0, v14.18.0
577
577
  * @param start The starting IPv4 or IPv6 address in the range.
578
578
  * @param end The ending IPv4 or IPv6 address in the range.
579
579
  * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
@@ -582,7 +582,7 @@ declare module 'net' {
582
582
  addRange(start: SocketAddress, end: SocketAddress): void;
583
583
  /**
584
584
  * Adds a rule to block a range of IP addresses specified as a subnet mask.
585
- * @since v15.0.0
585
+ * @since v15.0.0, v14.18.0
586
586
  * @param net The network IPv4 or IPv6 address.
587
587
  * @param prefix The number of CIDR prefix bits. For IPv4, this must be a value between `0` and `32`. For IPv6, this must be between `0` and `128`.
588
588
  * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
@@ -606,7 +606,7 @@ declare module 'net' {
606
606
  * console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
607
607
  * console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true
608
608
  * ```
609
- * @since v15.0.0
609
+ * @since v15.0.0, v14.18.0
610
610
  * @param address The IP address to check
611
611
  * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`.
612
612
  */
@@ -754,26 +754,26 @@ declare module 'net' {
754
754
  port?: number | undefined;
755
755
  }
756
756
  /**
757
- * @since v15.14.0
757
+ * @since v15.14.0, v14.18.0
758
758
  */
759
759
  class SocketAddress {
760
760
  constructor(options: SocketAddressInitOptions);
761
761
  /**
762
762
  * Either \`'ipv4'\` or \`'ipv6'\`.
763
- * @since v15.14.0
763
+ * @since v15.14.0, v14.18.0
764
764
  */
765
765
  readonly address: string;
766
766
  /**
767
767
  * Either \`'ipv4'\` or \`'ipv6'\`.
768
- * @since v15.14.0
768
+ * @since v15.14.0, v14.18.0
769
769
  */
770
770
  readonly family: IPVersion;
771
771
  /**
772
- * @since v15.14.0
772
+ * @since v15.14.0, v14.18.0
773
773
  */
774
774
  readonly port: number;
775
775
  /**
776
- * @since v15.14.0
776
+ * @since v15.14.0, v14.18.0
777
777
  */
778
778
  readonly flowlabel: number;
779
779
  }
@@ -5,7 +5,7 @@
5
5
  * ```js
6
6
  * const os = require('os');
7
7
  * ```
8
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/os.js)
8
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/os.js)
9
9
  */
10
10
  declare module 'os' {
11
11
  interface CpuInfo {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "16.11.12",
3
+ "version": "17.0.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",
@@ -225,6 +225,6 @@
225
225
  },
226
226
  "scripts": {},
227
227
  "dependencies": {},
228
- "typesPublisherContentHash": "66478bcf856b451a83d797fa3c4495aeb7e18e217db90d6545b2711843bfe71c",
228
+ "typesPublisherContentHash": "6a6a3a40242455c8b732c50c33bcbbd96f68ccf65d366fbd96a6773223877826",
229
229
  "typeScriptVersion": "3.8"
230
230
  }
@@ -13,7 +13,7 @@ declare module 'path/win32' {
13
13
  * ```js
14
14
  * const path = require('path');
15
15
  * ```
16
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/path.js)
16
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/path.js)
17
17
  */
18
18
  declare module 'path' {
19
19
  namespace path {
@@ -26,7 +26,7 @@
26
26
  * performance.measure('A to B', 'A', 'B');
27
27
  * });
28
28
  * ```
29
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/perf_hooks.js)
29
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/perf_hooks.js)
30
30
  */
31
31
  declare module 'perf_hooks' {
32
32
  import { AsyncResource } from 'node:async_hooks';
@@ -485,7 +485,7 @@ declare module 'perf_hooks' {
485
485
  }
486
486
  interface RecordableHistogram extends Histogram {
487
487
  /**
488
- * @since v15.9.0
488
+ * @since v15.9.0, v14.18.0
489
489
  * @param val The amount to record in the histogram.
490
490
  */
491
491
  record(val: number | bigint): void;
@@ -494,7 +494,7 @@ declare module 'perf_hooks' {
494
494
  * previous call to `recordDelta()` and records that amount in the histogram.
495
495
  *
496
496
  * ## Examples
497
- * @since v15.9.0
497
+ * @since v15.9.0, v14.18.0
498
498
  */
499
499
  recordDelta(): void;
500
500
  }
@@ -546,7 +546,7 @@ declare module 'perf_hooks' {
546
546
  }
547
547
  /**
548
548
  * Returns a `RecordableHistogram`.
549
- * @since v15.9.0
549
+ * @since v15.9.0, v14.18.0
550
550
  */
551
551
  function createHistogram(options?: CreateHistogramOptions): RecordableHistogram;
552
552
  }
@@ -24,7 +24,7 @@
24
24
  * made available to developers as a convenience. Fixes or other modifications to
25
25
  * the module must be directed to the [Punycode.js](https://github.com/bestiejs/punycode.js) project.
26
26
  * @deprecated Since v7.0.0 - Deprecated
27
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/punycode.js)
27
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/punycode.js)
28
28
  */
29
29
  declare module 'punycode' {
30
30
  /**
@@ -9,7 +9,7 @@
9
9
  * The `querystring` API is considered Legacy. While it is still maintained,
10
10
  * new code should use the `URLSearchParams` API instead.
11
11
  * @deprecated Legacy
12
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/querystring.js)
12
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/querystring.js)
13
13
  */
14
14
  declare module 'querystring' {
15
15
  interface StringifyOptions {
@@ -1,32 +1,36 @@
1
1
  /**
2
- * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time. It can be accessed
3
- * using:
2
+ * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time.
3
+ *
4
+ * To use the promise-based APIs:
4
5
  *
5
6
  * ```js
6
- * const readline = require('readline');
7
+ * import * as readline from 'node:readline/promises';
8
+ * ```
9
+ *
10
+ * To use the callback and sync APIs:
11
+ *
12
+ * ```js
13
+ * import * as readline from 'node:readline';
7
14
  * ```
8
15
  *
9
16
  * The following simple example illustrates the basic use of the `readline` module.
10
17
  *
11
18
  * ```js
12
- * const readline = require('readline');
19
+ * import * as readline from 'node:readline/promises';
20
+ * import { stdin as input, stdout as output } from 'process';
21
+ *
22
+ * const rl = readline.createInterface({ input, output });
13
23
  *
14
- * const rl = readline.createInterface({
15
- * input: process.stdin,
16
- * output: process.stdout
17
- * });
24
+ * const answer = await rl.question('What do you think of Node.js? ');
18
25
  *
19
- * rl.question('What do you think of Node.js? ', (answer) => {
20
- * // TODO: Log the answer in a database
21
- * console.log(`Thank you for your valuable feedback: ${answer}`);
26
+ * console.log(`Thank you for your valuable feedback: ${answer}`);
22
27
  *
23
- * rl.close();
24
- * });
28
+ * rl.close();
25
29
  * ```
26
30
  *
27
31
  * Once this code is invoked, the Node.js application will not terminate until the`readline.Interface` is closed because the interface waits for data to be
28
32
  * received on the `input` stream.
29
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/readline.js)
33
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/readline.js)
30
34
  */
31
35
  declare module 'readline' {
32
36
  import { Abortable, EventEmitter } from 'node:events';
@@ -394,6 +398,109 @@ declare module 'readline' {
394
398
  * if (process.stdin.isTTY)
395
399
  * process.stdin.setRawMode(true);
396
400
  * ```
401
+ *
402
+ * ## Example: Tiny CLI
403
+ *
404
+ * The following example illustrates the use of `readline.Interface` class to
405
+ * implement a small command-line interface:
406
+ *
407
+ * ```js
408
+ * const readline = require('readline');
409
+ * const rl = readline.createInterface({
410
+ * input: process.stdin,
411
+ * output: process.stdout,
412
+ * prompt: 'OHAI> '
413
+ * });
414
+ *
415
+ * rl.prompt();
416
+ *
417
+ * rl.on('line', (line) => {
418
+ * switch (line.trim()) {
419
+ * case 'hello':
420
+ * console.log('world!');
421
+ * break;
422
+ * default:
423
+ * console.log(`Say what? I might have heard '${line.trim()}'`);
424
+ * break;
425
+ * }
426
+ * rl.prompt();
427
+ * }).on('close', () => {
428
+ * console.log('Have a great day!');
429
+ * process.exit(0);
430
+ * });
431
+ * ```
432
+ *
433
+ * ## Example: Read file stream line-by-Line
434
+ *
435
+ * A common use case for `readline` is to consume an input file one line at a
436
+ * time. The easiest way to do so is leveraging the `fs.ReadStream` API as
437
+ * well as a `for await...of` loop:
438
+ *
439
+ * ```js
440
+ * const fs = require('fs');
441
+ * const readline = require('readline');
442
+ *
443
+ * async function processLineByLine() {
444
+ * const fileStream = fs.createReadStream('input.txt');
445
+ *
446
+ * const rl = readline.createInterface({
447
+ * input: fileStream,
448
+ * crlfDelay: Infinity
449
+ * });
450
+ * // Note: we use the crlfDelay option to recognize all instances of CR LF
451
+ * // ('\r\n') in input.txt as a single line break.
452
+ *
453
+ * for await (const line of rl) {
454
+ * // Each line in input.txt will be successively available here as `line`.
455
+ * console.log(`Line from file: ${line}`);
456
+ * }
457
+ * }
458
+ *
459
+ * processLineByLine();
460
+ * ```
461
+ *
462
+ * Alternatively, one could use the `'line'` event:
463
+ *
464
+ * ```js
465
+ * const fs = require('fs');
466
+ * const readline = require('readline');
467
+ *
468
+ * const rl = readline.createInterface({
469
+ * input: fs.createReadStream('sample.txt'),
470
+ * crlfDelay: Infinity
471
+ * });
472
+ *
473
+ * rl.on('line', (line) => {
474
+ * console.log(`Line from file: ${line}`);
475
+ * });
476
+ * ```
477
+ *
478
+ * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied:
479
+ *
480
+ * ```js
481
+ * const { once } = require('events');
482
+ * const { createReadStream } = require('fs');
483
+ * const { createInterface } = require('readline');
484
+ *
485
+ * (async function processLineByLine() {
486
+ * try {
487
+ * const rl = createInterface({
488
+ * input: createReadStream('big-file.txt'),
489
+ * crlfDelay: Infinity
490
+ * });
491
+ *
492
+ * rl.on('line', (line) => {
493
+ * // Process the line.
494
+ * });
495
+ *
496
+ * await once(rl, 'close');
497
+ *
498
+ * console.log('File processed.');
499
+ * } catch (err) {
500
+ * console.error(err);
501
+ * }
502
+ * })();
503
+ * ```
397
504
  * @since v0.7.7
398
505
  */
399
506
  function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
@@ -6,7 +6,7 @@
6
6
  * ```js
7
7
  * const repl = require('repl');
8
8
  * ```
9
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/repl.js)
9
+ * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/repl.js)
10
10
  */
11
11
  declare module 'repl' {
12
12
  import { Interface, Completer, AsyncCompleter } from 'node:readline';