@alanszp/express 12.0.2 → 13.0.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 (180) hide show
  1. package/dist/helpers/getRequestBaseLog.d.ts +2 -0
  2. package/dist/helpers/getRequestBaseLog.js +9 -0
  3. package/dist/helpers/getRequestBaseLog.js.map +1 -0
  4. package/dist/helpers/renderErrorJson.d.ts +1 -0
  5. package/dist/helpers/renderErrorJson.js +10 -1
  6. package/dist/helpers/renderErrorJson.js.map +1 -1
  7. package/dist/index.d.ts +3 -1
  8. package/dist/index.js +3 -1
  9. package/dist/index.js.map +1 -1
  10. package/dist/middlewares/errorRequestHandlerMiddleware.d.ts +4 -0
  11. package/dist/middlewares/errorRequestHandlerMiddleware.js +68 -0
  12. package/dist/middlewares/errorRequestHandlerMiddleware.js.map +1 -0
  13. package/dist/middlewares/hasPermissions.d.ts +20 -0
  14. package/dist/middlewares/hasPermissions.js +90 -0
  15. package/dist/middlewares/hasPermissions.js.map +1 -0
  16. package/dist/middlewares/hasRoles.js +4 -4
  17. package/dist/middlewares/hasRoles.js.map +1 -1
  18. package/package.json +9 -10
  19. package/.gitignore +0 -3
  20. package/.npmignore +0 -3
  21. package/dist/middlewares/returnInternalServerError.d.ts +0 -4
  22. package/dist/middlewares/returnInternalServerError.js +0 -10
  23. package/dist/middlewares/returnInternalServerError.js.map +0 -1
  24. package/node_modules/@jest/expect-utils/LICENSE +0 -21
  25. package/node_modules/@jest/expect-utils/README.md +0 -5
  26. package/node_modules/@jest/expect-utils/build/index.d.ts +0 -93
  27. package/node_modules/@jest/expect-utils/build/index.js +0 -37
  28. package/node_modules/@jest/expect-utils/build/jasmineUtils.js +0 -282
  29. package/node_modules/@jest/expect-utils/build/types.js +0 -1
  30. package/node_modules/@jest/expect-utils/build/utils.js +0 -457
  31. package/node_modules/@jest/expect-utils/package.json +0 -33
  32. package/node_modules/@jest/types/LICENSE +0 -21
  33. package/node_modules/@jest/types/README.md +0 -30
  34. package/node_modules/@jest/types/build/Circus.js +0 -1
  35. package/node_modules/@jest/types/build/Config.js +0 -1
  36. package/node_modules/@jest/types/build/Global.js +0 -1
  37. package/node_modules/@jest/types/build/TestResult.js +0 -1
  38. package/node_modules/@jest/types/build/Transform.js +0 -1
  39. package/node_modules/@jest/types/build/index.d.ts +0 -1166
  40. package/node_modules/@jest/types/build/index.js +0 -1
  41. package/node_modules/@jest/types/package.json +0 -38
  42. package/node_modules/@types/jest/LICENSE +0 -21
  43. package/node_modules/@types/jest/README.md +0 -17
  44. package/node_modules/@types/jest/index.d.ts +0 -1608
  45. package/node_modules/@types/jest/package.json +0 -159
  46. package/node_modules/@types/node/LICENSE +0 -21
  47. package/node_modules/@types/node/README.md +0 -15
  48. package/node_modules/@types/node/assert/strict.d.ts +0 -8
  49. package/node_modules/@types/node/assert.d.ts +0 -996
  50. package/node_modules/@types/node/async_hooks.d.ts +0 -539
  51. package/node_modules/@types/node/buffer.d.ts +0 -2362
  52. package/node_modules/@types/node/child_process.d.ts +0 -1540
  53. package/node_modules/@types/node/cluster.d.ts +0 -432
  54. package/node_modules/@types/node/console.d.ts +0 -415
  55. package/node_modules/@types/node/constants.d.ts +0 -19
  56. package/node_modules/@types/node/crypto.d.ts +0 -4487
  57. package/node_modules/@types/node/dgram.d.ts +0 -596
  58. package/node_modules/@types/node/diagnostics_channel.d.ts +0 -545
  59. package/node_modules/@types/node/dns/promises.d.ts +0 -425
  60. package/node_modules/@types/node/dns.d.ts +0 -809
  61. package/node_modules/@types/node/dom-events.d.ts +0 -122
  62. package/node_modules/@types/node/domain.d.ts +0 -170
  63. package/node_modules/@types/node/events.d.ts +0 -879
  64. package/node_modules/@types/node/fs/promises.d.ts +0 -1239
  65. package/node_modules/@types/node/fs.d.ts +0 -4311
  66. package/node_modules/@types/node/globals.d.ts +0 -411
  67. package/node_modules/@types/node/globals.global.d.ts +0 -1
  68. package/node_modules/@types/node/http.d.ts +0 -1887
  69. package/node_modules/@types/node/http2.d.ts +0 -2382
  70. package/node_modules/@types/node/https.d.ts +0 -550
  71. package/node_modules/@types/node/index.d.ts +0 -88
  72. package/node_modules/@types/node/inspector.d.ts +0 -2747
  73. package/node_modules/@types/node/module.d.ts +0 -315
  74. package/node_modules/@types/node/net.d.ts +0 -949
  75. package/node_modules/@types/node/os.d.ts +0 -478
  76. package/node_modules/@types/node/package.json +0 -229
  77. package/node_modules/@types/node/path.d.ts +0 -191
  78. package/node_modules/@types/node/perf_hooks.d.ts +0 -645
  79. package/node_modules/@types/node/process.d.ts +0 -1561
  80. package/node_modules/@types/node/punycode.d.ts +0 -117
  81. package/node_modules/@types/node/querystring.d.ts +0 -141
  82. package/node_modules/@types/node/readline/promises.d.ts +0 -150
  83. package/node_modules/@types/node/readline.d.ts +0 -539
  84. package/node_modules/@types/node/repl.d.ts +0 -430
  85. package/node_modules/@types/node/stream/consumers.d.ts +0 -12
  86. package/node_modules/@types/node/stream/promises.d.ts +0 -83
  87. package/node_modules/@types/node/stream/web.d.ts +0 -366
  88. package/node_modules/@types/node/stream.d.ts +0 -1701
  89. package/node_modules/@types/node/string_decoder.d.ts +0 -67
  90. package/node_modules/@types/node/test.d.ts +0 -1465
  91. package/node_modules/@types/node/timers/promises.d.ts +0 -93
  92. package/node_modules/@types/node/timers.d.ts +0 -240
  93. package/node_modules/@types/node/tls.d.ts +0 -1210
  94. package/node_modules/@types/node/trace_events.d.ts +0 -182
  95. package/node_modules/@types/node/ts4.8/assert/strict.d.ts +0 -8
  96. package/node_modules/@types/node/ts4.8/assert.d.ts +0 -996
  97. package/node_modules/@types/node/ts4.8/async_hooks.d.ts +0 -539
  98. package/node_modules/@types/node/ts4.8/buffer.d.ts +0 -2362
  99. package/node_modules/@types/node/ts4.8/child_process.d.ts +0 -1540
  100. package/node_modules/@types/node/ts4.8/cluster.d.ts +0 -432
  101. package/node_modules/@types/node/ts4.8/console.d.ts +0 -415
  102. package/node_modules/@types/node/ts4.8/constants.d.ts +0 -19
  103. package/node_modules/@types/node/ts4.8/crypto.d.ts +0 -4487
  104. package/node_modules/@types/node/ts4.8/dgram.d.ts +0 -596
  105. package/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +0 -545
  106. package/node_modules/@types/node/ts4.8/dns/promises.d.ts +0 -425
  107. package/node_modules/@types/node/ts4.8/dns.d.ts +0 -809
  108. package/node_modules/@types/node/ts4.8/dom-events.d.ts +0 -122
  109. package/node_modules/@types/node/ts4.8/domain.d.ts +0 -170
  110. package/node_modules/@types/node/ts4.8/events.d.ts +0 -879
  111. package/node_modules/@types/node/ts4.8/fs/promises.d.ts +0 -1239
  112. package/node_modules/@types/node/ts4.8/fs.d.ts +0 -4311
  113. package/node_modules/@types/node/ts4.8/globals.d.ts +0 -411
  114. package/node_modules/@types/node/ts4.8/globals.global.d.ts +0 -1
  115. package/node_modules/@types/node/ts4.8/http.d.ts +0 -1887
  116. package/node_modules/@types/node/ts4.8/http2.d.ts +0 -2382
  117. package/node_modules/@types/node/ts4.8/https.d.ts +0 -550
  118. package/node_modules/@types/node/ts4.8/index.d.ts +0 -88
  119. package/node_modules/@types/node/ts4.8/inspector.d.ts +0 -2747
  120. package/node_modules/@types/node/ts4.8/module.d.ts +0 -315
  121. package/node_modules/@types/node/ts4.8/net.d.ts +0 -949
  122. package/node_modules/@types/node/ts4.8/os.d.ts +0 -478
  123. package/node_modules/@types/node/ts4.8/path.d.ts +0 -191
  124. package/node_modules/@types/node/ts4.8/perf_hooks.d.ts +0 -645
  125. package/node_modules/@types/node/ts4.8/process.d.ts +0 -1561
  126. package/node_modules/@types/node/ts4.8/punycode.d.ts +0 -117
  127. package/node_modules/@types/node/ts4.8/querystring.d.ts +0 -141
  128. package/node_modules/@types/node/ts4.8/readline/promises.d.ts +0 -150
  129. package/node_modules/@types/node/ts4.8/readline.d.ts +0 -539
  130. package/node_modules/@types/node/ts4.8/repl.d.ts +0 -430
  131. package/node_modules/@types/node/ts4.8/stream/consumers.d.ts +0 -12
  132. package/node_modules/@types/node/ts4.8/stream/promises.d.ts +0 -83
  133. package/node_modules/@types/node/ts4.8/stream/web.d.ts +0 -366
  134. package/node_modules/@types/node/ts4.8/stream.d.ts +0 -1701
  135. package/node_modules/@types/node/ts4.8/string_decoder.d.ts +0 -67
  136. package/node_modules/@types/node/ts4.8/test.d.ts +0 -1465
  137. package/node_modules/@types/node/ts4.8/timers/promises.d.ts +0 -93
  138. package/node_modules/@types/node/ts4.8/timers.d.ts +0 -240
  139. package/node_modules/@types/node/ts4.8/tls.d.ts +0 -1210
  140. package/node_modules/@types/node/ts4.8/trace_events.d.ts +0 -182
  141. package/node_modules/@types/node/ts4.8/tty.d.ts +0 -208
  142. package/node_modules/@types/node/ts4.8/url.d.ts +0 -927
  143. package/node_modules/@types/node/ts4.8/util.d.ts +0 -2183
  144. package/node_modules/@types/node/ts4.8/v8.d.ts +0 -764
  145. package/node_modules/@types/node/ts4.8/vm.d.ts +0 -903
  146. package/node_modules/@types/node/ts4.8/wasi.d.ts +0 -179
  147. package/node_modules/@types/node/ts4.8/worker_threads.d.ts +0 -691
  148. package/node_modules/@types/node/ts4.8/zlib.d.ts +0 -517
  149. package/node_modules/@types/node/tty.d.ts +0 -208
  150. package/node_modules/@types/node/url.d.ts +0 -927
  151. package/node_modules/@types/node/util.d.ts +0 -2183
  152. package/node_modules/@types/node/v8.d.ts +0 -764
  153. package/node_modules/@types/node/vm.d.ts +0 -903
  154. package/node_modules/@types/node/wasi.d.ts +0 -179
  155. package/node_modules/@types/node/worker_threads.d.ts +0 -691
  156. package/node_modules/@types/node/zlib.d.ts +0 -517
  157. package/src/helpers/getIp.ts +0 -5
  158. package/src/helpers/getRequestLogger.ts +0 -6
  159. package/src/helpers/now.ts +0 -3
  160. package/src/helpers/renderErrorJson.ts +0 -29
  161. package/src/index.ts +0 -10
  162. package/src/middlewares/accessLogger.ts +0 -34
  163. package/src/middlewares/auditLog.ts +0 -52
  164. package/src/middlewares/authedForOrg.ts +0 -50
  165. package/src/middlewares/authenticateUser.test.ts +0 -403
  166. package/src/middlewares/authenticateUser.ts +0 -171
  167. package/src/middlewares/createContext.test.ts +0 -85
  168. package/src/middlewares/createContext.ts +0 -49
  169. package/src/middlewares/hasRoles.ts +0 -24
  170. package/src/middlewares/jsonBodyParser.ts +0 -22
  171. package/src/middlewares/returnInternalServerError.ts +0 -15
  172. package/src/middlewares/returnNotFound.ts +0 -11
  173. package/src/test/mocks/authOptionsMocks.ts +0 -35
  174. package/src/test/mocks/expressMocks.ts +0 -33
  175. package/src/test/mocks/jwtUserMocks.ts +0 -19
  176. package/src/test/setup.test.ts +0 -15
  177. package/src/test/setup.ts +0 -3
  178. package/src/types/AuthMethod.ts +0 -27
  179. package/src/types/GenericRequest.ts +0 -3
  180. package/src/types/custom.d.ts +0 -20
@@ -1,366 +0,0 @@
1
- declare module "stream/web" {
2
- // stub module, pending copy&paste from .d.ts or manual impl
3
- // copy from lib.dom.d.ts
4
- interface ReadableWritablePair<R = any, W = any> {
5
- readable: ReadableStream<R>;
6
- /**
7
- * Provides a convenient, chainable way of piping this readable stream
8
- * through a transform stream (or any other { writable, readable }
9
- * pair). It simply pipes the stream into the writable side of the
10
- * supplied pair, and returns the readable side for further use.
11
- *
12
- * Piping a stream will lock it for the duration of the pipe, preventing
13
- * any other consumer from acquiring a reader.
14
- */
15
- writable: WritableStream<W>;
16
- }
17
- interface StreamPipeOptions {
18
- preventAbort?: boolean;
19
- preventCancel?: boolean;
20
- /**
21
- * Pipes this readable stream to a given writable stream destination.
22
- * The way in which the piping process behaves under various error
23
- * conditions can be customized with a number of passed options. It
24
- * returns a promise that fulfills when the piping process completes
25
- * successfully, or rejects if any errors were encountered.
26
- *
27
- * Piping a stream will lock it for the duration of the pipe, preventing
28
- * any other consumer from acquiring a reader.
29
- *
30
- * Errors and closures of the source and destination streams propagate
31
- * as follows:
32
- *
33
- * An error in this source readable stream will abort destination,
34
- * unless preventAbort is truthy. The returned promise will be rejected
35
- * with the source's error, or with any error that occurs during
36
- * aborting the destination.
37
- *
38
- * An error in destination will cancel this source readable stream,
39
- * unless preventCancel is truthy. The returned promise will be rejected
40
- * with the destination's error, or with any error that occurs during
41
- * canceling the source.
42
- *
43
- * When this source readable stream closes, destination will be closed,
44
- * unless preventClose is truthy. The returned promise will be fulfilled
45
- * once this process completes, unless an error is encountered while
46
- * closing the destination, in which case it will be rejected with that
47
- * error.
48
- *
49
- * If destination starts out closed or closing, this source readable
50
- * stream will be canceled, unless preventCancel is true. The returned
51
- * promise will be rejected with an error indicating piping to a closed
52
- * stream failed, or with any error that occurs during canceling the
53
- * source.
54
- *
55
- * The signal option can be set to an AbortSignal to allow aborting an
56
- * ongoing pipe operation via the corresponding AbortController. In this
57
- * case, this source readable stream will be canceled, and destination
58
- * aborted, unless the respective options preventCancel or preventAbort
59
- * are set.
60
- */
61
- preventClose?: boolean;
62
- signal?: AbortSignal;
63
- }
64
- interface ReadableStreamGenericReader {
65
- readonly closed: Promise<undefined>;
66
- cancel(reason?: any): Promise<void>;
67
- }
68
- interface ReadableStreamDefaultReadValueResult<T> {
69
- done: false;
70
- value: T;
71
- }
72
- interface ReadableStreamDefaultReadDoneResult {
73
- done: true;
74
- value?: undefined;
75
- }
76
- type ReadableStreamController<T> = ReadableStreamDefaultController<T>;
77
- type ReadableStreamDefaultReadResult<T> =
78
- | ReadableStreamDefaultReadValueResult<T>
79
- | ReadableStreamDefaultReadDoneResult;
80
- interface ReadableStreamReadValueResult<T> {
81
- done: false;
82
- value: T;
83
- }
84
- interface ReadableStreamReadDoneResult<T> {
85
- done: true;
86
- value?: T;
87
- }
88
- type ReadableStreamReadResult<T> = ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>;
89
- interface ReadableByteStreamControllerCallback {
90
- (controller: ReadableByteStreamController): void | PromiseLike<void>;
91
- }
92
- interface UnderlyingSinkAbortCallback {
93
- (reason?: any): void | PromiseLike<void>;
94
- }
95
- interface UnderlyingSinkCloseCallback {
96
- (): void | PromiseLike<void>;
97
- }
98
- interface UnderlyingSinkStartCallback {
99
- (controller: WritableStreamDefaultController): any;
100
- }
101
- interface UnderlyingSinkWriteCallback<W> {
102
- (chunk: W, controller: WritableStreamDefaultController): void | PromiseLike<void>;
103
- }
104
- interface UnderlyingSourceCancelCallback {
105
- (reason?: any): void | PromiseLike<void>;
106
- }
107
- interface UnderlyingSourcePullCallback<R> {
108
- (controller: ReadableStreamController<R>): void | PromiseLike<void>;
109
- }
110
- interface UnderlyingSourceStartCallback<R> {
111
- (controller: ReadableStreamController<R>): any;
112
- }
113
- interface TransformerFlushCallback<O> {
114
- (controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
115
- }
116
- interface TransformerStartCallback<O> {
117
- (controller: TransformStreamDefaultController<O>): any;
118
- }
119
- interface TransformerTransformCallback<I, O> {
120
- (chunk: I, controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
121
- }
122
- interface UnderlyingByteSource {
123
- autoAllocateChunkSize?: number;
124
- cancel?: ReadableStreamErrorCallback;
125
- pull?: ReadableByteStreamControllerCallback;
126
- start?: ReadableByteStreamControllerCallback;
127
- type: "bytes";
128
- }
129
- interface UnderlyingSource<R = any> {
130
- cancel?: UnderlyingSourceCancelCallback;
131
- pull?: UnderlyingSourcePullCallback<R>;
132
- start?: UnderlyingSourceStartCallback<R>;
133
- type?: undefined;
134
- }
135
- interface UnderlyingSink<W = any> {
136
- abort?: UnderlyingSinkAbortCallback;
137
- close?: UnderlyingSinkCloseCallback;
138
- start?: UnderlyingSinkStartCallback;
139
- type?: undefined;
140
- write?: UnderlyingSinkWriteCallback<W>;
141
- }
142
- interface ReadableStreamErrorCallback {
143
- (reason: any): void | PromiseLike<void>;
144
- }
145
- /** This Streams API interface represents a readable stream of byte data. */
146
- interface ReadableStream<R = any> {
147
- readonly locked: boolean;
148
- cancel(reason?: any): Promise<void>;
149
- getReader(): ReadableStreamDefaultReader<R>;
150
- getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
151
- pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>;
152
- pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>;
153
- tee(): [ReadableStream<R>, ReadableStream<R>];
154
- values(options?: { preventCancel?: boolean }): AsyncIterableIterator<R>;
155
- [Symbol.asyncIterator](): AsyncIterableIterator<R>;
156
- }
157
- const ReadableStream: {
158
- prototype: ReadableStream;
159
- new(underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>;
160
- new<R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
161
- };
162
- interface ReadableStreamDefaultReader<R = any> extends ReadableStreamGenericReader {
163
- read(): Promise<ReadableStreamDefaultReadResult<R>>;
164
- releaseLock(): void;
165
- }
166
- interface ReadableStreamBYOBReader extends ReadableStreamGenericReader {
167
- read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamReadResult<T>>;
168
- releaseLock(): void;
169
- }
170
- const ReadableStreamDefaultReader: {
171
- prototype: ReadableStreamDefaultReader;
172
- new<R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
173
- };
174
- const ReadableStreamBYOBReader: any;
175
- const ReadableStreamBYOBRequest: any;
176
- interface ReadableByteStreamController {
177
- readonly byobRequest: undefined;
178
- readonly desiredSize: number | null;
179
- close(): void;
180
- enqueue(chunk: ArrayBufferView): void;
181
- error(error?: any): void;
182
- }
183
- const ReadableByteStreamController: {
184
- prototype: ReadableByteStreamController;
185
- new(): ReadableByteStreamController;
186
- };
187
- interface ReadableStreamDefaultController<R = any> {
188
- readonly desiredSize: number | null;
189
- close(): void;
190
- enqueue(chunk?: R): void;
191
- error(e?: any): void;
192
- }
193
- const ReadableStreamDefaultController: {
194
- prototype: ReadableStreamDefaultController;
195
- new(): ReadableStreamDefaultController;
196
- };
197
- interface Transformer<I = any, O = any> {
198
- flush?: TransformerFlushCallback<O>;
199
- readableType?: undefined;
200
- start?: TransformerStartCallback<O>;
201
- transform?: TransformerTransformCallback<I, O>;
202
- writableType?: undefined;
203
- }
204
- interface TransformStream<I = any, O = any> {
205
- readonly readable: ReadableStream<O>;
206
- readonly writable: WritableStream<I>;
207
- }
208
- const TransformStream: {
209
- prototype: TransformStream;
210
- new<I = any, O = any>(
211
- transformer?: Transformer<I, O>,
212
- writableStrategy?: QueuingStrategy<I>,
213
- readableStrategy?: QueuingStrategy<O>,
214
- ): TransformStream<I, O>;
215
- };
216
- interface TransformStreamDefaultController<O = any> {
217
- readonly desiredSize: number | null;
218
- enqueue(chunk?: O): void;
219
- error(reason?: any): void;
220
- terminate(): void;
221
- }
222
- const TransformStreamDefaultController: {
223
- prototype: TransformStreamDefaultController;
224
- new(): TransformStreamDefaultController;
225
- };
226
- /**
227
- * This Streams API interface provides a standard abstraction for writing
228
- * streaming data to a destination, known as a sink. This object comes with
229
- * built-in back pressure and queuing.
230
- */
231
- interface WritableStream<W = any> {
232
- readonly locked: boolean;
233
- abort(reason?: any): Promise<void>;
234
- close(): Promise<void>;
235
- getWriter(): WritableStreamDefaultWriter<W>;
236
- }
237
- const WritableStream: {
238
- prototype: WritableStream;
239
- new<W = any>(underlyingSink?: UnderlyingSink<W>, strategy?: QueuingStrategy<W>): WritableStream<W>;
240
- };
241
- /**
242
- * This Streams API interface is the object returned by
243
- * WritableStream.getWriter() and once created locks the < writer to the
244
- * WritableStream ensuring that no other streams can write to the underlying
245
- * sink.
246
- */
247
- interface WritableStreamDefaultWriter<W = any> {
248
- readonly closed: Promise<undefined>;
249
- readonly desiredSize: number | null;
250
- readonly ready: Promise<undefined>;
251
- abort(reason?: any): Promise<void>;
252
- close(): Promise<void>;
253
- releaseLock(): void;
254
- write(chunk?: W): Promise<void>;
255
- }
256
- const WritableStreamDefaultWriter: {
257
- prototype: WritableStreamDefaultWriter;
258
- new<W = any>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
259
- };
260
- /**
261
- * This Streams API interface represents a controller allowing control of a
262
- * WritableStream's state. When constructing a WritableStream, the
263
- * underlying sink is given a corresponding WritableStreamDefaultController
264
- * instance to manipulate.
265
- */
266
- interface WritableStreamDefaultController {
267
- error(e?: any): void;
268
- }
269
- const WritableStreamDefaultController: {
270
- prototype: WritableStreamDefaultController;
271
- new(): WritableStreamDefaultController;
272
- };
273
- interface QueuingStrategy<T = any> {
274
- highWaterMark?: number;
275
- size?: QueuingStrategySize<T>;
276
- }
277
- interface QueuingStrategySize<T = any> {
278
- (chunk?: T): number;
279
- }
280
- interface QueuingStrategyInit {
281
- /**
282
- * Creates a new ByteLengthQueuingStrategy with the provided high water
283
- * mark.
284
- *
285
- * Note that the provided high water mark will not be validated ahead of
286
- * time. Instead, if it is negative, NaN, or not a number, the resulting
287
- * ByteLengthQueuingStrategy will cause the corresponding stream
288
- * constructor to throw.
289
- */
290
- highWaterMark: number;
291
- }
292
- /**
293
- * This Streams API interface provides a built-in byte length queuing
294
- * strategy that can be used when constructing streams.
295
- */
296
- interface ByteLengthQueuingStrategy extends QueuingStrategy<ArrayBufferView> {
297
- readonly highWaterMark: number;
298
- readonly size: QueuingStrategySize<ArrayBufferView>;
299
- }
300
- const ByteLengthQueuingStrategy: {
301
- prototype: ByteLengthQueuingStrategy;
302
- new(init: QueuingStrategyInit): ByteLengthQueuingStrategy;
303
- };
304
- /**
305
- * This Streams API interface provides a built-in byte length queuing
306
- * strategy that can be used when constructing streams.
307
- */
308
- interface CountQueuingStrategy extends QueuingStrategy {
309
- readonly highWaterMark: number;
310
- readonly size: QueuingStrategySize;
311
- }
312
- const CountQueuingStrategy: {
313
- prototype: CountQueuingStrategy;
314
- new(init: QueuingStrategyInit): CountQueuingStrategy;
315
- };
316
- interface TextEncoderStream {
317
- /** Returns "utf-8". */
318
- readonly encoding: "utf-8";
319
- readonly readable: ReadableStream<Uint8Array>;
320
- readonly writable: WritableStream<string>;
321
- readonly [Symbol.toStringTag]: string;
322
- }
323
- const TextEncoderStream: {
324
- prototype: TextEncoderStream;
325
- new(): TextEncoderStream;
326
- };
327
- interface TextDecoderOptions {
328
- fatal?: boolean;
329
- ignoreBOM?: boolean;
330
- }
331
- type BufferSource = ArrayBufferView | ArrayBuffer;
332
- interface TextDecoderStream {
333
- /** Returns encoding's name, lower cased. */
334
- readonly encoding: string;
335
- /** Returns `true` if error mode is "fatal", and `false` otherwise. */
336
- readonly fatal: boolean;
337
- /** Returns `true` if ignore BOM flag is set, and `false` otherwise. */
338
- readonly ignoreBOM: boolean;
339
- readonly readable: ReadableStream<string>;
340
- readonly writable: WritableStream<BufferSource>;
341
- readonly [Symbol.toStringTag]: string;
342
- }
343
- const TextDecoderStream: {
344
- prototype: TextDecoderStream;
345
- new(encoding?: string, options?: TextDecoderOptions): TextDecoderStream;
346
- };
347
- interface CompressionStream<R = any, W = any> {
348
- readonly readable: ReadableStream<R>;
349
- readonly writable: WritableStream<W>;
350
- }
351
- const CompressionStream: {
352
- prototype: CompressionStream;
353
- new<R = any, W = any>(format: string): CompressionStream<R, W>;
354
- };
355
- interface DecompressionStream<R = any, W = any> {
356
- readonly readable: ReadableStream<R>;
357
- readonly writable: WritableStream<W>;
358
- }
359
- const DecompressionStream: {
360
- prototype: DecompressionStream;
361
- new<R = any, W = any>(format: string): DecompressionStream<R, W>;
362
- };
363
- }
364
- declare module "node:stream/web" {
365
- export * from "stream/web";
366
- }