undici-types 7.9.0 → 7.11.0

package/diagnostics-channel.d.ts

@@ -31,6 +31,15 @@ declare namespace DiagnosticsChannel {
   export interface RequestBodySentMessage {
     request: Request;
   }
+
+  export interface RequestBodyChunkSentMessage {
+    request: Request;
+    chunk: Uint8Array | string;
+  }
+  export interface RequestBodyChunkReceivedMessage {
+    request: Request;
+    chunk: Buffer;
+  }
   export interface RequestHeadersMessage {
     request: Request;
     response: Response;

package/dispatcher.d.ts

@@ -97,7 +97,8 @@ declare class Dispatcher extends EventEmitter {
 
 declare namespace Dispatcher {
   export interface ComposedDispatcher extends Dispatcher {}
-  export type DispatcherComposeInterceptor = (dispatch: Dispatcher['dispatch']) => Dispatcher['dispatch']
+  export type Dispatch = Dispatcher['dispatch']
+  export type DispatcherComposeInterceptor = (dispatch: Dispatch) => Dispatch
   export interface DispatchOptions {
     origin?: string | URL;
     path: string;
@@ -276,6 +277,6 @@ declare namespace Dispatcher {
   }
 
   export interface DispatchInterceptor {
-    (dispatch: Dispatcher['dispatch']): Dispatcher['dispatch']
+    (dispatch: Dispatch): Dispatch
   }
 }

package/env-http-proxy-agent.d.ts

@@ -1,4 +1,5 @@
 import Agent from './agent'
+import ProxyAgent from './proxy-agent'
 import Dispatcher from './dispatcher'
 
 export default EnvHttpProxyAgent
@@ -10,7 +11,7 @@ declare class EnvHttpProxyAgent extends Dispatcher {
 }
 
 declare namespace EnvHttpProxyAgent {
-  export interface Options extends Agent.Options {
+  export interface Options extends Omit<ProxyAgent.Options, 'uri'> {
     /** Overrides the value of the HTTP_PROXY environment variable  */
     httpProxy?: string;
     /** Overrides the value of the HTTPS_PROXY environment variable  */

package/eventsource.d.ts

@@ -18,9 +18,9 @@ interface EventSource extends EventTarget {
   readonly CLOSED: 2
   readonly CONNECTING: 0
   readonly OPEN: 1
-  onerror: (this: EventSource, ev: ErrorEvent) => any
-  onmessage: (this: EventSource, ev: MessageEvent) => any
-  onopen: (this: EventSource, ev: Event) => any
+  onerror: ((this: EventSource, ev: ErrorEvent) => any) | null
+  onmessage: ((this: EventSource, ev: MessageEvent) => any) | null
+  onopen: ((this: EventSource, ev: Event) => any) | null
   readonly readyState: 0 | 1 | 2
   readonly url: string
   readonly withCredentials: boolean

package/fetch.d.ts

@@ -33,6 +33,7 @@ export class BodyMixin {
 
   readonly arrayBuffer: () => Promise<ArrayBuffer>
   readonly blob: () => Promise<Blob>
+  readonly bytes: () => Promise<Uint8Array>
   /**
    * @deprecated This method is not recommended for parsing multipart/form-data bodies in server environments.
    * It is recommended to use a library such as [@fastify/busboy](https://www.npmjs.com/package/@fastify/busboy) as follows:

package/handlers.d.ts

@@ -2,7 +2,7 @@ import Dispatcher from './dispatcher'
 
 export declare class RedirectHandler implements Dispatcher.DispatchHandler {
   constructor (
-    dispatch: Dispatcher,
+    dispatch: Dispatcher.Dispatch,
     maxRedirections: number,
     opts: Dispatcher.DispatchOptions,
     handler: Dispatcher.DispatchHandler,

package/mock-client.d.ts

@@ -14,6 +14,8 @@ declare class MockClient extends Client implements Interceptable {
   dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandler): boolean
   /** Closes the mock client and gracefully waits for enqueued requests to complete. */
   close (): Promise<void>
+  /** Clean up all the prepared mocks. */
+  cleanMocks (): void
 }
 
 declare namespace MockClient {

package/mock-interceptor.d.ts

@@ -84,6 +84,8 @@ declare namespace MockInterceptor {
 interface Interceptable extends Dispatcher {
   /** Intercepts any matching requests that use the same origin as this mock client. */
   intercept(options: MockInterceptor.Options): MockInterceptor;
+  /** Clean up all the prepared mocks. */
+  cleanMocks (): void
 }
 
 export {

package/mock-pool.d.ts

@@ -14,6 +14,8 @@ declare class MockPool extends Pool implements Interceptable {
   dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandler): boolean
   /** Closes the mock pool and gracefully waits for enqueued requests to complete. */
   close (): Promise<void>
+  /** Clean up all the prepared mocks. */
+  cleanMocks (): void
 }
 
 declare namespace MockPool {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "undici-types",
-  "version": "7.9.0",
+  "version": "7.11.0",
   "description": "A stand-alone types package for Undici",
   "homepage": "https://undici.nodejs.org",
   "bugs": {

package/pool.d.ts

@@ -33,6 +33,8 @@ declare namespace Pool {
     factory?(origin: URL, opts: object): Dispatcher;
     /** The max number of clients to create. `null` if no limit. Default `null`. */
     connections?: number | null;
+    /** The amount of time before a client is removed from the pool and closed. `null` if no time limit. Default `null` */
+    clientTtl?: number | null;
 
     interceptors?: { Pool?: readonly Dispatcher.DispatchInterceptor[] } & Client.Options['interceptors']
   }

package/proxy-agent.d.ts

@@ -24,5 +24,6 @@ declare namespace ProxyAgent {
     requestTls?: buildConnector.BuildOptions;
     proxyTls?: buildConnector.BuildOptions;
     clientFactory?(origin: URL, opts: object): Dispatcher;
+    proxyTunnel?: boolean;
   }
 }

package/retry-handler.d.ts

@@ -35,6 +35,15 @@ declare namespace RetryHandler {
   ) => void
 
   export interface RetryOptions {
+    /**
+     * If true, the retry handler will throw an error if the request fails,
+     * this will prevent the folling handlers from being called, and will destroy the socket.
+     *
+     * @type {boolean}
+     * @memberof RetryOptions
+     * @default true
+     */
+    throwOnError?: boolean;
     /**
      * Callback to be invoked on every retry iteration.
      * It receives the error, current state of the retry object and the options object

package/webidl.d.ts

@@ -16,9 +16,12 @@ interface ConvertToIntOpts {
 }
 
 interface WebidlErrors {
+  /**
+   * @description Instantiate an error
+   */
   exception (opts: { header: string, message: string }): TypeError
   /**
-   * @description Throw an error when conversion from one type to another has failed
+   * @description Instantiate an error when conversion from one type to another has failed
    */
   conversionFailed (opts: {
     prefix: string
@@ -75,7 +78,7 @@ interface WebidlUtil {
   ): number
 
   /**
-   * @see https://webidl.spec.whatwg.org/#abstract-opdef-converttoint
+   * @see https://webidl.spec.whatwg.org/#abstract-opdef-integerpart
    */
   IntegerPart (N: number): number
 
@@ -182,20 +185,21 @@ interface WebidlConverters {
   [Key: string]: (...args: any[]) => unknown
 }
 
-type IsAssertion<T> = (arg: any) => arg is T
+type WebidlIsFunction<T> = (arg: any) => arg is T
 
 interface WebidlIs {
-  Request: IsAssertion<undici.Request>
-  Response: IsAssertion<undici.Response>
-  ReadableStream: IsAssertion<ReadableStream>
-  Blob: IsAssertion<Blob>
-  URLSearchParams: IsAssertion<URLSearchParams>
-  File: IsAssertion<File>
-  FormData: IsAssertion<undici.FormData>
-  URL: IsAssertion<URL>
-  WebSocketError: IsAssertion<undici.WebSocketError>
-  AbortSignal: IsAssertion<AbortSignal>
-  MessagePort: IsAssertion<MessagePort>
+  Request: WebidlIsFunction<undici.Request>
+  Response: WebidlIsFunction<undici.Response>
+  ReadableStream: WebidlIsFunction<ReadableStream>
+  Blob: WebidlIsFunction<Blob>
+  URLSearchParams: WebidlIsFunction<URLSearchParams>
+  File: WebidlIsFunction<File>
+  FormData: WebidlIsFunction<undici.FormData>
+  URL: WebidlIsFunction<URL>
+  WebSocketError: WebidlIsFunction<undici.WebSocketError>
+  AbortSignal: WebidlIsFunction<AbortSignal>
+  MessagePort: WebidlIsFunction<MessagePort>
+  USVString: WebidlIsFunction<string>
 }
 
 export interface Webidl {
@@ -233,7 +237,7 @@ export interface Webidl {
    * Similar to {@link Webidl.brandCheck} but allows skipping the check if third party
    * interfaces are allowed.
    */
-  interfaceConverter <Interface>(typeCheck: IsAssertion<Interface>, name: string): (
+  interfaceConverter <Interface>(typeCheck: WebidlIsFunction<Interface>, name: string): (
     V: unknown,
     prefix: string,
     argument: string

package/websocket.d.ts

@@ -136,7 +136,7 @@ interface ErrorEvent extends Event {
   readonly filename: string
   readonly lineno: number
   readonly colno: number
-  readonly error: any
+  readonly error: Error
 }
 
 export declare const ErrorEvent: {