@idlebox/stripe-node-types 24.0.14-patch.0 → 24.0.15

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 (134) hide show
  1. package/README.md +1 -1
  2. package/assert/strict.d.ts +113 -1
  3. package/assert.d.ts +162 -248
  4. package/async_hooks.d.ts +20 -5
  5. package/buffer.buffer.d.ts +24 -6
  6. package/buffer.d.ts +63 -168
  7. package/child_process.d.ts +117 -223
  8. package/cluster.d.ts +251 -329
  9. package/compatibility/iterators.d.ts +15 -0
  10. package/console.d.ts +60 -346
  11. package/constants.d.ts +15 -1
  12. package/crypto.d.ts +713 -1149
  13. package/dgram.d.ts +30 -50
  14. package/diagnostics_channel.d.ts +16 -3
  15. package/dns/promises.d.ts +15 -0
  16. package/dns.d.ts +150 -131
  17. package/domain.d.ts +25 -14
  18. package/events.d.ts +858 -719
  19. package/fs/promises.d.ts +117 -53
  20. package/fs.d.ts +729 -484
  21. package/globals.d.ts +142 -344
  22. package/globals.typedarray.d.ts +94 -0
  23. package/http.d.ts +358 -246
  24. package/http2.d.ts +578 -711
  25. package/https.d.ts +85 -216
  26. package/index.d.ts +39 -3
  27. package/inspector/promises.d.ts +54 -0
  28. package/inspector.d.ts +180 -3936
  29. package/inspector.generated.d.ts +4242 -0
  30. package/module.d.ts +60 -95
  31. package/my-shim.d.ts +15 -0
  32. package/net.d.ts +102 -186
  33. package/os.d.ts +32 -6
  34. package/package.json +3 -8
  35. package/path/posix.d.ts +20 -0
  36. package/path/win32.d.ts +20 -0
  37. package/path.d.ts +132 -122
  38. package/perf_hooks.d.ts +310 -644
  39. package/process.d.ts +192 -138
  40. package/punycode.d.ts +17 -2
  41. package/querystring.d.ts +16 -1
  42. package/quic.d.ts +926 -0
  43. package/readline/promises.d.ts +16 -1
  44. package/readline.d.ts +80 -118
  45. package/repl.d.ts +98 -96
  46. package/sea.d.ts +25 -1
  47. package/sqlite.d.ts +277 -13
  48. package/stream/consumers.d.ts +22 -7
  49. package/stream/promises.d.ts +148 -12
  50. package/stream/web.d.ts +187 -494
  51. package/stream.d.ts +608 -490
  52. package/string_decoder.d.ts +18 -3
  53. package/test/reporters.d.ts +112 -0
  54. package/test.d.ts +238 -199
  55. package/timers/promises.d.ts +16 -1
  56. package/timers.d.ts +16 -129
  57. package/tls.d.ts +163 -163
  58. package/trace_events.d.ts +21 -6
  59. package/ts5.6/buffer.buffer.d.ts +25 -8
  60. package/ts5.6/compatibility/float16array.d.ts +15 -0
  61. package/ts5.6/globals.typedarray.d.ts +31 -0
  62. package/ts5.6/index.d.ts +39 -3
  63. package/ts5.7/compatibility/float16array.d.ts +15 -0
  64. package/ts5.7/index.d.ts +39 -3
  65. package/tty.d.ts +70 -13
  66. package/undici-types/agent.d.ts +20 -4
  67. package/undici-types/api.d.ts +15 -0
  68. package/undici-types/balanced-pool.d.ts +15 -0
  69. package/undici-types/cache-interceptor.d.ts +15 -0
  70. package/undici-types/cache.d.ts +15 -0
  71. package/undici-types/client-stats.d.ts +31 -0
  72. package/undici-types/client.d.ts +21 -5
  73. package/undici-types/connector.d.ts +15 -0
  74. package/undici-types/content-type.d.ts +15 -0
  75. package/undici-types/cookies.d.ts +15 -0
  76. package/undici-types/diagnostics-channel.d.ts +24 -1
  77. package/undici-types/dispatcher.d.ts +18 -8
  78. package/undici-types/env-http-proxy-agent.d.ts +17 -1
  79. package/undici-types/errors.d.ts +20 -15
  80. package/undici-types/eventsource.d.ts +24 -4
  81. package/undici-types/fetch.d.ts +16 -0
  82. package/undici-types/formdata.d.ts +15 -0
  83. package/undici-types/global-dispatcher.d.ts +15 -0
  84. package/undici-types/global-origin.d.ts +15 -0
  85. package/undici-types/h2c-client.d.ts +15 -2
  86. package/undici-types/handlers.d.ts +16 -1
  87. package/undici-types/header.d.ts +15 -0
  88. package/undici-types/index.d.ts +21 -1
  89. package/undici-types/interceptors.d.ts +20 -0
  90. package/undici-types/mock-agent.d.ts +18 -0
  91. package/undici-types/mock-call-history.d.ts +15 -0
  92. package/undici-types/mock-client.d.ts +17 -0
  93. package/undici-types/mock-errors.d.ts +15 -0
  94. package/undici-types/mock-interceptor.d.ts +17 -1
  95. package/undici-types/mock-pool.d.ts +17 -0
  96. package/undici-types/package.json +1 -1
  97. package/undici-types/patch.d.ts +15 -0
  98. package/undici-types/pool-stats.d.ts +15 -0
  99. package/undici-types/pool.d.ts +17 -0
  100. package/undici-types/proxy-agent.d.ts +16 -0
  101. package/undici-types/readable.d.ts +15 -0
  102. package/undici-types/retry-agent.d.ts +15 -0
  103. package/undici-types/retry-handler.d.ts +24 -0
  104. package/undici-types/snapshot-agent.d.ts +125 -0
  105. package/undici-types/util.d.ts +15 -0
  106. package/undici-types/utility.d.ts +15 -0
  107. package/undici-types/webidl.d.ts +126 -36
  108. package/undici-types/websocket.d.ts +18 -1
  109. package/url.d.ts +107 -587
  110. package/util/types.d.ts +571 -0
  111. package/util.d.ts +158 -792
  112. package/v8.d.ts +82 -7
  113. package/vm.d.ts +267 -108
  114. package/wasi.d.ts +38 -2
  115. package/web-globals/abortcontroller.d.ts +75 -0
  116. package/web-globals/blob.d.ts +39 -0
  117. package/web-globals/console.d.ts +25 -0
  118. package/web-globals/crypto.d.ts +55 -0
  119. package/web-globals/domexception.d.ts +84 -0
  120. package/web-globals/encoding.d.ts +27 -0
  121. package/{dom-events.d.ts → web-globals/events.d.ts} +72 -50
  122. package/web-globals/fetch.d.ts +70 -0
  123. package/web-globals/importmeta.d.ts +29 -0
  124. package/web-globals/messaging.d.ts +39 -0
  125. package/web-globals/navigator.d.ts +41 -0
  126. package/web-globals/performance.d.ts +61 -0
  127. package/web-globals/storage.d.ts +40 -0
  128. package/web-globals/streams.d.ts +131 -0
  129. package/web-globals/timers.d.ts +60 -0
  130. package/web-globals/url.d.ts +40 -0
  131. package/worker_threads.d.ts +306 -349
  132. package/zlib.d.ts +59 -94
  133. package/ts5.1/compatibility/disposable.d.ts +0 -13
  134. package/ts5.1/index.d.ts +0 -100
package/stream/web.d.ts CHANGED
@@ -1,118 +1,107 @@
1
- type _ByteLengthQueuingStrategy = typeof globalThis extends { onmessage: any } ? {}
2
- : import('node:stream/web').ByteLengthQueuingStrategy;
3
- type _CompressionStream = typeof globalThis extends { onmessage: any; ReportingObserver: any } ? {}
4
- : import('node:stream/web').CompressionStream;
5
- type _CountQueuingStrategy = typeof globalThis extends { onmessage: any } ? {}
6
- : import('node:stream/web').CountQueuingStrategy;
7
- type _DecompressionStream = typeof globalThis extends { onmessage: any; ReportingObserver: any } ? {}
8
- : import('node:stream/web').DecompressionStream;
9
- type _ReadableByteStreamController = typeof globalThis extends { onmessage: any } ? {}
10
- : import('node:stream/web').ReadableByteStreamController;
11
- type _ReadableStream<R = any> = typeof globalThis extends { onmessage: any } ? {}
12
- : import('node:stream/web').ReadableStream<R>;
13
- type _ReadableStreamBYOBReader = typeof globalThis extends { onmessage: any } ? {}
14
- : import('node:stream/web').ReadableStreamBYOBReader;
15
- type _ReadableStreamBYOBRequest = typeof globalThis extends { onmessage: any } ? {}
16
- : import('node:stream/web').ReadableStreamBYOBRequest;
17
- type _ReadableStreamDefaultController<R = any> = typeof globalThis extends { onmessage: any } ? {}
18
- : import('node:stream/web').ReadableStreamDefaultController<R>;
19
- type _ReadableStreamDefaultReader<R = any> = typeof globalThis extends { onmessage: any } ? {}
20
- : import('node:stream/web').ReadableStreamDefaultReader<R>;
21
- type _TextDecoderStream = typeof globalThis extends { onmessage: any } ? {}
22
- : import('node:stream/web').TextDecoderStream;
23
- type _TextEncoderStream = typeof globalThis extends { onmessage: any } ? {}
24
- : import('node:stream/web').TextEncoderStream;
25
- type _TransformStream<I = any, O = any> = typeof globalThis extends { onmessage: any } ? {}
26
- : import('node:stream/web').TransformStream<I, O>;
27
- type _TransformStreamDefaultController<O = any> = typeof globalThis extends { onmessage: any } ? {}
28
- : import('node:stream/web').TransformStreamDefaultController<O>;
29
- type _WritableStream<W = any> = typeof globalThis extends { onmessage: any } ? {}
30
- : import('node:stream/web').WritableStream<W>;
31
- type _WritableStreamDefaultController = typeof globalThis extends { onmessage: any } ? {}
32
- : import('node:stream/web').WritableStreamDefaultController;
33
- type _WritableStreamDefaultWriter<W = any> = typeof globalThis extends { onmessage: any } ? {}
34
- : import('node:stream/web').WritableStreamDefaultWriter<W>;
1
+ // biome-ignore-all lint: generated file
2
+ // biome-ignore-all assist: generated file
3
+ /* eslint-disable */
4
+ // @ts-ignore
5
+
6
+ /******************************************************************************
7
+ * GENERATED FILE, DO NOT MODIFY
8
+ * 这是生成的文件,千万不要修改
9
+ *
10
+ * @build-script/codegen - The Simple Code Generater
11
+ * https://github.com/GongT/baobao
12
+ *
13
+ ******************************************************************************/
14
+
35
15
 
36
16
 
37
17
  declare module "node:stream/web" {
38
- // stub module, pending copy&paste from .d.ts or manual impl
39
- // copy from lib.dom.d.ts
18
+ import { TextDecoderCommon, TextDecoderOptions, TextEncoderCommon } from 'node:util';
19
+ type CompressionFormat = "brotli" | "deflate" | "deflate-raw" | "gzip";
20
+ type ReadableStreamController<T> = ReadableStreamDefaultController<T> | ReadableByteStreamController;
21
+ type ReadableStreamReader<T> = ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader;
22
+ type ReadableStreamReaderMode = "byob";
23
+ type ReadableStreamReadResult<T> = ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>;
24
+ type ReadableStreamType = "bytes";
25
+ interface GenericTransformStream {
26
+ readonly readable: ReadableStream;
27
+ readonly writable: WritableStream;
28
+ }
29
+ interface QueuingStrategy<T = any> {
30
+ highWaterMark?: number;
31
+ size?: QueuingStrategySize<T>;
32
+ }
33
+ interface QueuingStrategyInit {
34
+ highWaterMark: number;
35
+ }
36
+ interface QueuingStrategySize<T = any> {
37
+ (chunk: T): number;
38
+ }
39
+ interface ReadableStreamBYOBReaderReadOptions {
40
+ min?: number;
41
+ }
42
+ interface ReadableStreamGenericReader {
43
+ readonly closed: Promise<void>;
44
+ cancel(reason?: any): Promise<void>;
45
+ }
46
+ interface ReadableStreamGetReaderOptions {
47
+ mode?: ReadableStreamReaderMode;
48
+ }
49
+ interface ReadableStreamIteratorOptions {
50
+ preventCancel?: boolean;
51
+ }
52
+ interface ReadableStreamReadDoneResult<T> {
53
+ done: true;
54
+ value: T | undefined;
55
+ }
56
+ interface ReadableStreamReadValueResult<T> {
57
+ done: false;
58
+ value: T;
59
+ }
40
60
  interface ReadableWritablePair<R = any, W = any> {
41
61
  readable: ReadableStream<R>;
42
- /**
43
- * Provides a convenient, chainable way of piping this readable stream
44
- * through a transform stream (or any other { writable, readable }
45
- * pair). It simply pipes the stream into the writable side of the
46
- * supplied pair, and returns the readable side for further use.
47
- *
48
- * Piping a stream will lock it for the duration of the pipe, preventing
49
- * any other consumer from acquiring a reader.
50
- */
51
62
  writable: WritableStream<W>;
52
63
  }
53
64
  interface StreamPipeOptions {
54
65
  preventAbort?: boolean;
55
66
  preventCancel?: boolean;
56
- /**
57
- * Pipes this readable stream to a given writable stream destination.
58
- * The way in which the piping process behaves under various error
59
- * conditions can be customized with a number of passed options. It
60
- * returns a promise that fulfills when the piping process completes
61
- * successfully, or rejects if any errors were encountered.
62
- *
63
- * Piping a stream will lock it for the duration of the pipe, preventing
64
- * any other consumer from acquiring a reader.
65
- *
66
- * Errors and closures of the source and destination streams propagate
67
- * as follows:
68
- *
69
- * An error in this source readable stream will abort destination,
70
- * unless preventAbort is truthy. The returned promise will be rejected
71
- * with the source's error, or with any error that occurs during
72
- * aborting the destination.
73
- *
74
- * An error in destination will cancel this source readable stream,
75
- * unless preventCancel is truthy. The returned promise will be rejected
76
- * with the destination's error, or with any error that occurs during
77
- * canceling the source.
78
- *
79
- * When this source readable stream closes, destination will be closed,
80
- * unless preventClose is truthy. The returned promise will be fulfilled
81
- * once this process completes, unless an error is encountered while
82
- * closing the destination, in which case it will be rejected with that
83
- * error.
84
- *
85
- * If destination starts out closed or closing, this source readable
86
- * stream will be canceled, unless preventCancel is true. The returned
87
- * promise will be rejected with an error indicating piping to a closed
88
- * stream failed, or with any error that occurs during canceling the
89
- * source.
90
- *
91
- * The signal option can be set to an AbortSignal to allow aborting an
92
- * ongoing pipe operation via the corresponding AbortController. In this
93
- * case, this source readable stream will be canceled, and destination
94
- * aborted, unless the respective options preventCancel or preventAbort
95
- * are set.
96
- */
97
67
  preventClose?: boolean;
98
68
  signal?: AbortSignal;
99
69
  }
100
- interface ReadableStreamGenericReader {
101
- readonly closed: Promise<void>;
102
- cancel(reason?: any): Promise<void>;
70
+ interface Transformer<I = any, O = any> {
71
+ flush?: TransformerFlushCallback<O>;
72
+ readableType?: undefined;
73
+ start?: TransformerStartCallback<O>;
74
+ transform?: TransformerTransformCallback<I, O>;
75
+ writableType?: undefined;
103
76
  }
104
- type ReadableStreamController<T> = ReadableStreamDefaultController<T>;
105
- interface ReadableStreamReadValueResult<T> {
106
- done: false;
107
- value: T;
77
+ interface TransformerFlushCallback<O> {
78
+ (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
108
79
  }
109
- interface ReadableStreamReadDoneResult<T> {
110
- done: true;
111
- value?: T;
80
+ interface TransformerStartCallback<O> {
81
+ (controller: TransformStreamDefaultController<O>): any;
112
82
  }
113
- type ReadableStreamReadResult<T> = ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>;
114
- interface ReadableByteStreamControllerCallback {
115
- (controller: ReadableByteStreamController): void | PromiseLike<void>;
83
+ interface TransformerTransformCallback<I, O> {
84
+ (chunk: I, controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
85
+ }
86
+ interface UnderlyingByteSource {
87
+ autoAllocateChunkSize?: number;
88
+ cancel?: UnderlyingSourceCancelCallback;
89
+ pull?: (controller: ReadableByteStreamController) => void | PromiseLike<void>;
90
+ start?: (controller: ReadableByteStreamController) => any;
91
+ type: "bytes";
92
+ }
93
+ interface UnderlyingDefaultSource<R = any> {
94
+ cancel?: UnderlyingSourceCancelCallback;
95
+ pull?: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>;
96
+ start?: (controller: ReadableStreamDefaultController<R>) => any;
97
+ type?: undefined;
98
+ }
99
+ interface UnderlyingSink<W = any> {
100
+ abort?: UnderlyingSinkAbortCallback;
101
+ close?: UnderlyingSinkCloseCallback;
102
+ start?: UnderlyingSinkStartCallback;
103
+ type?: undefined;
104
+ write?: UnderlyingSinkWriteCallback<W>;
116
105
  }
117
106
  interface UnderlyingSinkAbortCallback {
118
107
  (reason?: any): void | PromiseLike<void>;
@@ -126,6 +115,13 @@ declare module "node:stream/web" {
126
115
  interface UnderlyingSinkWriteCallback<W> {
127
116
  (chunk: W, controller: WritableStreamDefaultController): void | PromiseLike<void>;
128
117
  }
118
+ interface UnderlyingSource<R = any> {
119
+ autoAllocateChunkSize?: number;
120
+ cancel?: UnderlyingSourceCancelCallback;
121
+ pull?: UnderlyingSourcePullCallback<R>;
122
+ start?: UnderlyingSourceStartCallback<R>;
123
+ type?: ReadableStreamType;
124
+ }
129
125
  interface UnderlyingSourceCancelCallback {
130
126
  (reason?: any): void | PromiseLike<void>;
131
127
  }
@@ -135,45 +131,49 @@ declare module "node:stream/web" {
135
131
  interface UnderlyingSourceStartCallback<R> {
136
132
  (controller: ReadableStreamController<R>): any;
137
133
  }
138
- interface TransformerFlushCallback<O> {
139
- (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
140
- }
141
- interface TransformerStartCallback<O> {
142
- (controller: TransformStreamDefaultController<O>): any;
143
- }
144
- interface TransformerTransformCallback<I, O> {
145
- (chunk: I, controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
146
- }
147
- interface TransformerCancelCallback {
148
- (reason: any): void | PromiseLike<void>;
149
- }
150
- interface UnderlyingByteSource {
151
- autoAllocateChunkSize?: number;
152
- cancel?: ReadableStreamErrorCallback;
153
- pull?: ReadableByteStreamControllerCallback;
154
- start?: ReadableByteStreamControllerCallback;
155
- type: "bytes";
134
+ interface ByteLengthQueuingStrategy extends QueuingStrategy<NodeJS.ArrayBufferView> {
135
+ readonly highWaterMark: number;
136
+ readonly size: QueuingStrategySize<NodeJS.ArrayBufferView>;
156
137
  }
157
- interface UnderlyingSource<R = any> {
158
- cancel?: UnderlyingSourceCancelCallback;
159
- pull?: UnderlyingSourcePullCallback<R>;
160
- start?: UnderlyingSourceStartCallback<R>;
161
- type?: undefined;
138
+ var ByteLengthQueuingStrategy: {
139
+ prototype: ByteLengthQueuingStrategy;
140
+ new(init: QueuingStrategyInit): ByteLengthQueuingStrategy;
141
+ };
142
+ interface CompressionStream extends GenericTransformStream {
143
+ readonly readable: ReadableStream<NodeJS.NonSharedUint8Array>;
144
+ readonly writable: WritableStream<NodeJS.BufferSource>;
162
145
  }
163
- interface UnderlyingSink<W = any> {
164
- abort?: UnderlyingSinkAbortCallback;
165
- close?: UnderlyingSinkCloseCallback;
166
- start?: UnderlyingSinkStartCallback;
167
- type?: undefined;
168
- write?: UnderlyingSinkWriteCallback<W>;
146
+ var CompressionStream: {
147
+ prototype: CompressionStream;
148
+ new(format: CompressionFormat): CompressionStream;
149
+ };
150
+ interface CountQueuingStrategy extends QueuingStrategy {
151
+ readonly highWaterMark: number;
152
+ readonly size: QueuingStrategySize;
169
153
  }
170
- interface ReadableStreamErrorCallback {
171
- (reason: any): void | PromiseLike<void>;
154
+ var CountQueuingStrategy: {
155
+ prototype: CountQueuingStrategy;
156
+ new(init: QueuingStrategyInit): CountQueuingStrategy;
157
+ };
158
+ interface DecompressionStream extends GenericTransformStream {
159
+ readonly readable: ReadableStream<NodeJS.NonSharedUint8Array>;
160
+ readonly writable: WritableStream<NodeJS.BufferSource>;
172
161
  }
173
- interface ReadableStreamAsyncIterator<T> extends NodeJS.AsyncIterator<T, NodeJS.BuiltinIteratorReturn, unknown> {
174
- [Symbol.asyncIterator](): ReadableStreamAsyncIterator<T>;
162
+ var DecompressionStream: {
163
+ prototype: DecompressionStream;
164
+ new(format: CompressionFormat): DecompressionStream;
165
+ };
166
+ interface ReadableByteStreamController {
167
+ readonly byobRequest: ReadableStreamBYOBRequest | null;
168
+ readonly desiredSize: number | null;
169
+ close(): void;
170
+ enqueue(chunk: NodeJS.NonSharedArrayBufferView): void;
171
+ error(e?: any): void;
175
172
  }
176
- /** This Streams API interface represents a readable stream of byte data. */
173
+ var ReadableByteStreamController: {
174
+ prototype: ReadableByteStreamController;
175
+ new(): ReadableByteStreamController;
176
+ };
177
177
  interface ReadableStream<R = any> {
178
178
  readonly locked: boolean;
179
179
  cancel(reason?: any): Promise<void>;
@@ -183,96 +183,81 @@ declare module "node:stream/web" {
183
183
  pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>;
184
184
  pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>;
185
185
  tee(): [ReadableStream<R>, ReadableStream<R>];
186
- values(options?: { preventCancel?: boolean }): ReadableStreamAsyncIterator<R>;
187
- [Symbol.asyncIterator](): ReadableStreamAsyncIterator<R>;
186
+ [Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
187
+ values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
188
188
  }
189
- const ReadableStream: {
189
+ var ReadableStream: {
190
190
  prototype: ReadableStream;
191
- from<T>(iterable: Iterable<T> | AsyncIterable<T>): ReadableStream<T>;
192
- new(underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>;
191
+ new(
192
+ underlyingSource: UnderlyingByteSource,
193
+ strategy?: { highWaterMark?: number },
194
+ ): ReadableStream<NodeJS.NonSharedUint8Array>;
195
+ new<R = any>(underlyingSource: UnderlyingDefaultSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
193
196
  new<R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
197
+ from<R = any>(iterable: Iterable<R> | AsyncIterable<R>): ReadableStream<R>;
194
198
  };
195
- type ReadableStreamReaderMode = "byob";
196
- interface ReadableStreamGetReaderOptions {
197
- /**
198
- * Creates a ReadableStreamBYOBReader and locks the stream to the new reader.
199
- *
200
- * This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation.
201
- */
202
- mode?: ReadableStreamReaderMode;
203
- }
204
- type ReadableStreamReader<T> = ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader;
205
- interface ReadableStreamDefaultReader<R = any> extends ReadableStreamGenericReader {
206
- read(): Promise<ReadableStreamReadResult<R>>;
207
- releaseLock(): void;
199
+ interface ReadableStreamAsyncIterator<T> extends NodeJS.AsyncIterator<T, NodeJS.BuiltinIteratorReturn, unknown> {
200
+ [Symbol.asyncIterator](): ReadableStreamAsyncIterator<T>;
208
201
  }
209
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) */
210
202
  interface ReadableStreamBYOBReader extends ReadableStreamGenericReader {
211
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) */
212
- read<T extends ArrayBufferView>(
203
+ read<T extends NodeJS.NonSharedArrayBufferView>(
213
204
  view: T,
214
- options?: {
215
- min?: number;
216
- },
205
+ options?: ReadableStreamBYOBReaderReadOptions,
217
206
  ): Promise<ReadableStreamReadResult<T>>;
218
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) */
219
207
  releaseLock(): void;
220
208
  }
221
- const ReadableStreamDefaultReader: {
222
- prototype: ReadableStreamDefaultReader;
223
- new<R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
224
- };
225
- const ReadableStreamBYOBReader: {
209
+ var ReadableStreamBYOBReader: {
226
210
  prototype: ReadableStreamBYOBReader;
227
- new(stream: ReadableStream): ReadableStreamBYOBReader;
211
+ new(stream: ReadableStream<NodeJS.NonSharedUint8Array>): ReadableStreamBYOBReader;
228
212
  };
229
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) */
230
213
  interface ReadableStreamBYOBRequest {
231
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) */
232
- readonly view: ArrayBufferView | null;
233
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) */
214
+ readonly view: NodeJS.NonSharedArrayBufferView | null;
234
215
  respond(bytesWritten: number): void;
235
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) */
236
- respondWithNewView(view: ArrayBufferView): void;
216
+ respondWithNewView(view: NodeJS.NonSharedArrayBufferView): void;
237
217
  }
238
- const ReadableStreamBYOBRequest: {
218
+ var ReadableStreamBYOBRequest: {
239
219
  prototype: ReadableStreamBYOBRequest;
240
220
  new(): ReadableStreamBYOBRequest;
241
221
  };
242
- interface ReadableByteStreamController {
243
- readonly byobRequest: undefined;
244
- readonly desiredSize: number | null;
245
- close(): void;
246
- enqueue(chunk: ArrayBufferView): void;
247
- error(error?: any): void;
248
- }
249
- const ReadableByteStreamController: {
250
- prototype: ReadableByteStreamController;
251
- new(): ReadableByteStreamController;
252
- };
253
222
  interface ReadableStreamDefaultController<R = any> {
254
223
  readonly desiredSize: number | null;
255
224
  close(): void;
256
225
  enqueue(chunk?: R): void;
257
226
  error(e?: any): void;
258
227
  }
259
- const ReadableStreamDefaultController: {
228
+ var ReadableStreamDefaultController: {
260
229
  prototype: ReadableStreamDefaultController;
261
230
  new(): ReadableStreamDefaultController;
262
231
  };
263
- interface Transformer<I = any, O = any> {
264
- flush?: TransformerFlushCallback<O>;
265
- readableType?: undefined;
266
- start?: TransformerStartCallback<O>;
267
- transform?: TransformerTransformCallback<I, O>;
268
- cancel?: TransformerCancelCallback;
269
- writableType?: undefined;
232
+ interface ReadableStreamDefaultReader<R = any> extends ReadableStreamGenericReader {
233
+ read(): Promise<ReadableStreamReadResult<R>>;
234
+ releaseLock(): void;
270
235
  }
236
+ var ReadableStreamDefaultReader: {
237
+ prototype: ReadableStreamDefaultReader;
238
+ new<R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
239
+ };
240
+ interface TextDecoderStream extends GenericTransformStream, TextDecoderCommon {
241
+ readonly readable: ReadableStream<string>;
242
+ readonly writable: WritableStream<NodeJS.BufferSource>;
243
+ }
244
+ var TextDecoderStream: {
245
+ prototype: TextDecoderStream;
246
+ new(label?: string, options?: TextDecoderOptions): TextDecoderStream;
247
+ };
248
+ interface TextEncoderStream extends GenericTransformStream, TextEncoderCommon {
249
+ readonly readable: ReadableStream<NodeJS.NonSharedUint8Array>;
250
+ readonly writable: WritableStream<string>;
251
+ }
252
+ var TextEncoderStream: {
253
+ prototype: TextEncoderStream;
254
+ new(): TextEncoderStream;
255
+ };
271
256
  interface TransformStream<I = any, O = any> {
272
257
  readonly readable: ReadableStream<O>;
273
258
  readonly writable: WritableStream<I>;
274
259
  }
275
- const TransformStream: {
260
+ var TransformStream: {
276
261
  prototype: TransformStream;
277
262
  new<I = any, O = any>(
278
263
  transformer?: Transformer<I, O>,
@@ -286,31 +271,28 @@ declare module "node:stream/web" {
286
271
  error(reason?: any): void;
287
272
  terminate(): void;
288
273
  }
289
- const TransformStreamDefaultController: {
274
+ var TransformStreamDefaultController: {
290
275
  prototype: TransformStreamDefaultController;
291
276
  new(): TransformStreamDefaultController;
292
277
  };
293
- /**
294
- * This Streams API interface provides a standard abstraction for writing
295
- * streaming data to a destination, known as a sink. This object comes with
296
- * built-in back pressure and queuing.
297
- */
298
278
  interface WritableStream<W = any> {
299
279
  readonly locked: boolean;
300
280
  abort(reason?: any): Promise<void>;
301
281
  close(): Promise<void>;
302
282
  getWriter(): WritableStreamDefaultWriter<W>;
303
283
  }
304
- const WritableStream: {
284
+ var WritableStream: {
305
285
  prototype: WritableStream;
306
286
  new<W = any>(underlyingSink?: UnderlyingSink<W>, strategy?: QueuingStrategy<W>): WritableStream<W>;
307
287
  };
308
- /**
309
- * This Streams API interface is the object returned by
310
- * WritableStream.getWriter() and once created locks the < writer to the
311
- * WritableStream ensuring that no other streams can write to the underlying
312
- * sink.
313
- */
288
+ interface WritableStreamDefaultController {
289
+ readonly signal: AbortSignal;
290
+ error(e?: any): void;
291
+ }
292
+ var WritableStreamDefaultController: {
293
+ prototype: WritableStreamDefaultController;
294
+ new(): WritableStreamDefaultController;
295
+ };
314
296
  interface WritableStreamDefaultWriter<W = any> {
315
297
  readonly closed: Promise<void>;
316
298
  readonly desiredSize: number | null;
@@ -320,297 +302,8 @@ declare module "node:stream/web" {
320
302
  releaseLock(): void;
321
303
  write(chunk?: W): Promise<void>;
322
304
  }
323
- const WritableStreamDefaultWriter: {
305
+ var WritableStreamDefaultWriter: {
324
306
  prototype: WritableStreamDefaultWriter;
325
307
  new<W = any>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
326
308
  };
327
- /**
328
- * This Streams API interface represents a controller allowing control of a
329
- * WritableStream's state. When constructing a WritableStream, the
330
- * underlying sink is given a corresponding WritableStreamDefaultController
331
- * instance to manipulate.
332
- */
333
- interface WritableStreamDefaultController {
334
- error(e?: any): void;
335
- }
336
- const WritableStreamDefaultController: {
337
- prototype: WritableStreamDefaultController;
338
- new(): WritableStreamDefaultController;
339
- };
340
- interface QueuingStrategy<T = any> {
341
- highWaterMark?: number;
342
- size?: QueuingStrategySize<T>;
343
- }
344
- interface QueuingStrategySize<T = any> {
345
- (chunk?: T): number;
346
- }
347
- interface QueuingStrategyInit {
348
- /**
349
- * Creates a new ByteLengthQueuingStrategy with the provided high water
350
- * mark.
351
- *
352
- * Note that the provided high water mark will not be validated ahead of
353
- * time. Instead, if it is negative, NaN, or not a number, the resulting
354
- * ByteLengthQueuingStrategy will cause the corresponding stream
355
- * constructor to throw.
356
- */
357
- highWaterMark: number;
358
- }
359
- /**
360
- * This Streams API interface provides a built-in byte length queuing
361
- * strategy that can be used when constructing streams.
362
- */
363
- interface ByteLengthQueuingStrategy extends QueuingStrategy<ArrayBufferView> {
364
- readonly highWaterMark: number;
365
- readonly size: QueuingStrategySize<ArrayBufferView>;
366
- }
367
- const ByteLengthQueuingStrategy: {
368
- prototype: ByteLengthQueuingStrategy;
369
- new(init: QueuingStrategyInit): ByteLengthQueuingStrategy;
370
- };
371
- /**
372
- * This Streams API interface provides a built-in byte length queuing
373
- * strategy that can be used when constructing streams.
374
- */
375
- interface CountQueuingStrategy extends QueuingStrategy {
376
- readonly highWaterMark: number;
377
- readonly size: QueuingStrategySize;
378
- }
379
- const CountQueuingStrategy: {
380
- prototype: CountQueuingStrategy;
381
- new(init: QueuingStrategyInit): CountQueuingStrategy;
382
- };
383
- interface TextEncoderStream {
384
- /** Returns "utf-8". */
385
- readonly encoding: "utf-8";
386
- readonly readable: ReadableStream<Uint8Array>;
387
- readonly writable: WritableStream<string>;
388
- readonly [Symbol.toStringTag]: string;
389
- }
390
- const TextEncoderStream: {
391
- prototype: TextEncoderStream;
392
- new(): TextEncoderStream;
393
- };
394
- interface TextDecoderOptions {
395
- fatal?: boolean;
396
- ignoreBOM?: boolean;
397
- }
398
- type BufferSource = ArrayBufferView | ArrayBuffer;
399
- interface TextDecoderStream {
400
- /** Returns encoding's name, lower cased. */
401
- readonly encoding: string;
402
- /** Returns `true` if error mode is "fatal", and `false` otherwise. */
403
- readonly fatal: boolean;
404
- /** Returns `true` if ignore BOM flag is set, and `false` otherwise. */
405
- readonly ignoreBOM: boolean;
406
- readonly readable: ReadableStream<string>;
407
- readonly writable: WritableStream<BufferSource>;
408
- readonly [Symbol.toStringTag]: string;
409
- }
410
- const TextDecoderStream: {
411
- prototype: TextDecoderStream;
412
- new(encoding?: string, options?: TextDecoderOptions): TextDecoderStream;
413
- };
414
- interface CompressionStream {
415
- readonly readable: ReadableStream;
416
- readonly writable: WritableStream;
417
- }
418
- const CompressionStream: {
419
- prototype: CompressionStream;
420
- new(format: "deflate" | "deflate-raw" | "gzip"): CompressionStream;
421
- };
422
- interface DecompressionStream {
423
- readonly writable: WritableStream;
424
- readonly readable: ReadableStream;
425
- }
426
- const DecompressionStream: {
427
- prototype: DecompressionStream;
428
- new(format: "deflate" | "deflate-raw" | "gzip"): DecompressionStream;
429
- };
430
-
431
- global {
432
- interface ByteLengthQueuingStrategy extends _ByteLengthQueuingStrategy {}
433
- /**
434
- * `ByteLengthQueuingStrategy` class is a global reference for `import { ByteLengthQueuingStrategy } from 'node:stream/web'`.
435
- * https://nodejs.org/api/globals.html#class-bytelengthqueuingstrategy
436
- * @since v18.0.0
437
- */
438
- var ByteLengthQueuingStrategy: typeof globalThis extends { onmessage: any; ByteLengthQueuingStrategy: infer T }
439
- ? T
440
- : typeof import('node:stream/web').ByteLengthQueuingStrategy;
441
-
442
- interface CompressionStream extends _CompressionStream {}
443
- /**
444
- * `CompressionStream` class is a global reference for `import { CompressionStream } from 'node:stream/web'`.
445
- * https://nodejs.org/api/globals.html#class-compressionstream
446
- * @since v18.0.0
447
- */
448
- var CompressionStream: typeof globalThis extends {
449
- onmessage: any;
450
- // CompressionStream, DecompressionStream and ReportingObserver was introduced in the same commit.
451
- // If ReportingObserver check is removed, the type here will form a circular reference in TS5.0+lib.dom.d.ts
452
- ReportingObserver: any;
453
- CompressionStream: infer T;
454
- } ? T
455
- // TS 4.8, 4.9, 5.0
456
- : typeof globalThis extends { onmessage: any; TransformStream: { prototype: infer T } } ? {
457
- prototype: T;
458
- new(format: "deflate" | "deflate-raw" | "gzip"): T;
459
- }
460
- : typeof import('node:stream/web').CompressionStream;
461
-
462
- interface CountQueuingStrategy extends _CountQueuingStrategy {}
463
- /**
464
- * `CountQueuingStrategy` class is a global reference for `import { CountQueuingStrategy } from 'node:stream/web'`.
465
- * https://nodejs.org/api/globals.html#class-countqueuingstrategy
466
- * @since v18.0.0
467
- */
468
- var CountQueuingStrategy: typeof globalThis extends { onmessage: any; CountQueuingStrategy: infer T } ? T
469
- : typeof import('node:stream/web').CountQueuingStrategy;
470
-
471
- interface DecompressionStream extends _DecompressionStream {}
472
- /**
473
- * `DecompressionStream` class is a global reference for `import { DecompressionStream } from 'node:stream/web'`.
474
- * https://nodejs.org/api/globals.html#class-decompressionstream
475
- * @since v18.0.0
476
- */
477
- var DecompressionStream: typeof globalThis extends {
478
- onmessage: any;
479
- // CompressionStream, DecompressionStream and ReportingObserver was introduced in the same commit.
480
- // If ReportingObserver check is removed, the type here will form a circular reference in TS5.0+lib.dom.d.ts
481
- ReportingObserver: any;
482
- DecompressionStream: infer T extends object;
483
- } ? T
484
- // TS 4.8, 4.9, 5.0
485
- : typeof globalThis extends { onmessage: any; TransformStream: { prototype: infer T } } ? {
486
- prototype: T;
487
- new(format: "deflate" | "deflate-raw" | "gzip"): T;
488
- }
489
- : typeof import('node:stream/web').DecompressionStream;
490
-
491
- interface ReadableByteStreamController extends _ReadableByteStreamController {}
492
- /**
493
- * `ReadableByteStreamController` class is a global reference for `import { ReadableByteStreamController } from 'node:stream/web'`.
494
- * https://nodejs.org/api/globals.html#class-readablebytestreamcontroller
495
- * @since v18.0.0
496
- */
497
- var ReadableByteStreamController: typeof globalThis extends
498
- { onmessage: any; ReadableByteStreamController: infer T } ? T
499
- : typeof import('node:stream/web').ReadableByteStreamController;
500
-
501
- interface ReadableStream<R = any> extends _ReadableStream<R> {}
502
- /**
503
- * `ReadableStream` class is a global reference for `import { ReadableStream } from 'node:stream/web'`.
504
- * https://nodejs.org/api/globals.html#class-readablestream
505
- * @since v18.0.0
506
- */
507
- var ReadableStream: typeof globalThis extends { onmessage: any; ReadableStream: infer T } ? T
508
- : typeof import('node:stream/web').ReadableStream;
509
-
510
- interface ReadableStreamBYOBReader extends _ReadableStreamBYOBReader {}
511
- /**
512
- * `ReadableStreamBYOBReader` class is a global reference for `import { ReadableStreamBYOBReader } from 'node:stream/web'`.
513
- * https://nodejs.org/api/globals.html#class-readablestreambyobreader
514
- * @since v18.0.0
515
- */
516
- var ReadableStreamBYOBReader: typeof globalThis extends { onmessage: any; ReadableStreamBYOBReader: infer T }
517
- ? T
518
- : typeof import('node:stream/web').ReadableStreamBYOBReader;
519
-
520
- interface ReadableStreamBYOBRequest extends _ReadableStreamBYOBRequest {}
521
- /**
522
- * `ReadableStreamBYOBRequest` class is a global reference for `import { ReadableStreamBYOBRequest } from 'node:stream/web'`.
523
- * https://nodejs.org/api/globals.html#class-readablestreambyobrequest
524
- * @since v18.0.0
525
- */
526
- var ReadableStreamBYOBRequest: typeof globalThis extends { onmessage: any; ReadableStreamBYOBRequest: infer T }
527
- ? T
528
- : typeof import('node:stream/web').ReadableStreamBYOBRequest;
529
-
530
- interface ReadableStreamDefaultController<R = any> extends _ReadableStreamDefaultController<R> {}
531
- /**
532
- * `ReadableStreamDefaultController` class is a global reference for `import { ReadableStreamDefaultController } from 'node:stream/web'`.
533
- * https://nodejs.org/api/globals.html#class-readablestreamdefaultcontroller
534
- * @since v18.0.0
535
- */
536
- var ReadableStreamDefaultController: typeof globalThis extends
537
- { onmessage: any; ReadableStreamDefaultController: infer T } ? T
538
- : typeof import('node:stream/web').ReadableStreamDefaultController;
539
-
540
- interface ReadableStreamDefaultReader<R = any> extends _ReadableStreamDefaultReader<R> {}
541
- /**
542
- * `ReadableStreamDefaultReader` class is a global reference for `import { ReadableStreamDefaultReader } from 'node:stream/web'`.
543
- * https://nodejs.org/api/globals.html#class-readablestreamdefaultreader
544
- * @since v18.0.0
545
- */
546
- var ReadableStreamDefaultReader: typeof globalThis extends
547
- { onmessage: any; ReadableStreamDefaultReader: infer T } ? T
548
- : typeof import('node:stream/web').ReadableStreamDefaultReader;
549
-
550
- interface TextDecoderStream extends _TextDecoderStream {}
551
- /**
552
- * `TextDecoderStream` class is a global reference for `import { TextDecoderStream } from 'node:stream/web'`.
553
- * https://nodejs.org/api/globals.html#class-textdecoderstream
554
- * @since v18.0.0
555
- */
556
- var TextDecoderStream: typeof globalThis extends { onmessage: any; TextDecoderStream: infer T } ? T
557
- : typeof import('node:stream/web').TextDecoderStream;
558
-
559
- interface TextEncoderStream extends _TextEncoderStream {}
560
- /**
561
- * `TextEncoderStream` class is a global reference for `import { TextEncoderStream } from 'node:stream/web'`.
562
- * https://nodejs.org/api/globals.html#class-textencoderstream
563
- * @since v18.0.0
564
- */
565
- var TextEncoderStream: typeof globalThis extends { onmessage: any; TextEncoderStream: infer T } ? T
566
- : typeof import('node:stream/web').TextEncoderStream;
567
-
568
- interface TransformStream<I = any, O = any> extends _TransformStream<I, O> {}
569
- /**
570
- * `TransformStream` class is a global reference for `import { TransformStream } from 'node:stream/web'`.
571
- * https://nodejs.org/api/globals.html#class-transformstream
572
- * @since v18.0.0
573
- */
574
- var TransformStream: typeof globalThis extends { onmessage: any; TransformStream: infer T } ? T
575
- : typeof import('node:stream/web').TransformStream;
576
-
577
- interface TransformStreamDefaultController<O = any> extends _TransformStreamDefaultController<O> {}
578
- /**
579
- * `TransformStreamDefaultController` class is a global reference for `import { TransformStreamDefaultController } from 'node:stream/web'`.
580
- * https://nodejs.org/api/globals.html#class-transformstreamdefaultcontroller
581
- * @since v18.0.0
582
- */
583
- var TransformStreamDefaultController: typeof globalThis extends
584
- { onmessage: any; TransformStreamDefaultController: infer T } ? T
585
- : typeof import('node:stream/web').TransformStreamDefaultController;
586
-
587
- interface WritableStream<W = any> extends _WritableStream<W> {}
588
- /**
589
- * `WritableStream` class is a global reference for `import { WritableStream } from 'node:stream/web'`.
590
- * https://nodejs.org/api/globals.html#class-writablestream
591
- * @since v18.0.0
592
- */
593
- var WritableStream: typeof globalThis extends { onmessage: any; WritableStream: infer T } ? T
594
- : typeof import('node:stream/web').WritableStream;
595
-
596
- interface WritableStreamDefaultController extends _WritableStreamDefaultController {}
597
- /**
598
- * `WritableStreamDefaultController` class is a global reference for `import { WritableStreamDefaultController } from 'node:stream/web'`.
599
- * https://nodejs.org/api/globals.html#class-writablestreamdefaultcontroller
600
- * @since v18.0.0
601
- */
602
- var WritableStreamDefaultController: typeof globalThis extends
603
- { onmessage: any; WritableStreamDefaultController: infer T } ? T
604
- : typeof import('node:stream/web').WritableStreamDefaultController;
605
-
606
- interface WritableStreamDefaultWriter<W = any> extends _WritableStreamDefaultWriter<W> {}
607
- /**
608
- * `WritableStreamDefaultWriter` class is a global reference for `import { WritableStreamDefaultWriter } from 'node:stream/web'`.
609
- * https://nodejs.org/api/globals.html#class-writablestreamdefaultwriter
610
- * @since v18.0.0
611
- */
612
- var WritableStreamDefaultWriter: typeof globalThis extends
613
- { onmessage: any; WritableStreamDefaultWriter: infer T } ? T
614
- : typeof import('node:stream/web').WritableStreamDefaultWriter;
615
- }
616
309
  }