undici-types 6.21.0 → 7.0.0

package/pool-stats.d.ts

@@ -1,19 +1,19 @@
-import Pool from "./pool"
+import Pool from './pool'
 
 export default PoolStats
 
 declare class PoolStats {
-  constructor(pool: Pool);
+  constructor (pool: Pool)
   /** Number of open socket connections in this pool. */
-  connected: number;
+  connected: number
   /** Number of open socket connections in this pool that do not have an active request. */
-  free: number;
+  free: number
   /** Number of pending requests across all clients in this pool. */
-  pending: number;
+  pending: number
   /** Number of queued requests across all clients in this pool. */
-  queued: number;
+  queued: number
   /** Number of currently active requests across all clients in this pool. */
-  running: number;
+  running: number
   /** Number of active, pending, or queued requests across all clients in this pool. */
-  size: number;
+  size: number
 }

package/pool.d.ts

@@ -1,39 +1,39 @@
 import Client from './client'
 import TPoolStats from './pool-stats'
 import { URL } from 'url'
-import Dispatcher from "./dispatcher";
+import Dispatcher from './dispatcher'
 
 export default Pool
 
-type PoolConnectOptions = Omit<Dispatcher.ConnectOptions, "origin">;
+type PoolConnectOptions = Omit<Dispatcher.ConnectOptions, 'origin'>
 
 declare class Pool extends Dispatcher {
-  constructor(url: string | URL, options?: Pool.Options)
+  constructor (url: string | URL, options?: Pool.Options)
   /** `true` after `pool.close()` has been called. */
-  closed: boolean;
+  closed: boolean
   /** `true` after `pool.destroyed()` has been called or `pool.close()` has been called and the pool shutdown has completed. */
-  destroyed: boolean;
+  destroyed: boolean
   /** Aggregate stats for a Pool. */
-  readonly stats: TPoolStats;
+  readonly stats: TPoolStats
 
   // Override dispatcher APIs.
-  override connect(
+  override connect (
     options: PoolConnectOptions
-  ): Promise<Dispatcher.ConnectData>;
-  override connect(
+  ): Promise<Dispatcher.ConnectData>
+  override connect (
     options: PoolConnectOptions,
     callback: (err: Error | null, data: Dispatcher.ConnectData) => void
-  ): void;
+  ): void
 }
 
 declare namespace Pool {
-  export type PoolStats = TPoolStats;
+  export type PoolStats = TPoolStats
   export interface Options extends Client.Options {
     /** Default: `(origin, opts) => new Client(origin, opts)`. */
     factory?(origin: URL, opts: object): Dispatcher;
     /** The max number of clients to create. `null` if no limit. Default `null`. */
     connections?: number | null;
 
-    interceptors?: { Pool?: readonly Dispatcher.DispatchInterceptor[] } & Client.Options["interceptors"]
+    interceptors?: { Pool?: readonly Dispatcher.DispatchInterceptor[] } & Client.Options['interceptors']
   }
 }

package/proxy-agent.d.ts

@@ -1,15 +1,15 @@
 import Agent from './agent'
-import buildConnector from './connector';
+import buildConnector from './connector'
 import Dispatcher from './dispatcher'
 import { IncomingHttpHeaders } from './header'
 
 export default ProxyAgent
 
 declare class ProxyAgent extends Dispatcher {
-  constructor(options: ProxyAgent.Options | string)
+  constructor (options: ProxyAgent.Options | string)
 
-  dispatch(options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean;
-  close(): Promise<void>;
+  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
+  close (): Promise<void>
 }
 
 declare namespace ProxyAgent {

package/readable.d.ts

@@ -1,45 +1,47 @@
-import { Readable } from "stream";
+import { Readable } from 'stream'
 import { Blob } from 'buffer'
 
 export default BodyReadable
 
 declare class BodyReadable extends Readable {
-  constructor(
-    resume?: (this: Readable, size: number) => void | null,
-    abort?: () => void | null,
-    contentType?: string
-  )
+  constructor (opts: {
+    resume: (this: Readable, size: number) => void | null;
+    abort: () => void | null;
+    contentType?: string;
+    contentLength?: number;
+    highWaterMark?: number;
+  })
 
   /** Consumes and returns the body as a string
    *  https://fetch.spec.whatwg.org/#dom-body-text
    */
-  text(): Promise<string>
+  text (): Promise<string>
 
   /** Consumes and returns the body as a JavaScript Object
    *  https://fetch.spec.whatwg.org/#dom-body-json
    */
-  json(): Promise<unknown>
+  json (): Promise<unknown>
 
   /** Consumes and returns the body as a Blob
    *  https://fetch.spec.whatwg.org/#dom-body-blob
    */
-  blob(): Promise<Blob>
+  blob (): Promise<Blob>
 
   /** Consumes and returns the body as an Uint8Array
    *  https://fetch.spec.whatwg.org/#dom-body-bytes
    */
-  bytes(): Promise<Uint8Array>
+  bytes (): Promise<Uint8Array>
 
   /** Consumes and returns the body as an ArrayBuffer
    *  https://fetch.spec.whatwg.org/#dom-body-arraybuffer
    */
-  arrayBuffer(): Promise<ArrayBuffer>
+  arrayBuffer (): Promise<ArrayBuffer>
 
   /** Not implemented
    *
    *  https://fetch.spec.whatwg.org/#dom-body-formdata
    */
-  formData(): Promise<never>
+  formData (): Promise<never>
 
   /** Returns true if the body is not null and the body has been consumed
    *
@@ -49,7 +51,7 @@ declare class BodyReadable extends Readable {
    */
   readonly bodyUsed: boolean
 
-  /** 
+  /**
    * If body is null, it should return null as the body
    *
    *  If body is not null, should return the body as a ReadableStream
@@ -59,7 +61,8 @@ declare class BodyReadable extends Readable {
   readonly body: never | undefined
 
   /** Dumps the response body by reading `limit` number of bytes.
-   * @param opts.limit Number of bytes to read (optional) - Default: 262144
+   * @param opts.limit Number of bytes to read (optional) - Default: 131072
+   * @param opts.signal AbortSignal to cancel the operation (optional)
    */
-  dump(opts?: { limit: number }): Promise<void>
+  dump (opts?: { limit: number; signal?: AbortSignal }): Promise<void>
 }

package/retry-agent.d.ts

@@ -4,5 +4,5 @@ import RetryHandler from './retry-handler'
 export default RetryAgent
 
 declare class RetryAgent extends Dispatcher {
-  constructor(dispatcher: Dispatcher, options?: RetryHandler.RetryOptions)
+  constructor (dispatcher: Dispatcher, options?: RetryHandler.RetryOptions)
 }

package/retry-handler.d.ts

@@ -1,18 +1,18 @@
-import Dispatcher from "./dispatcher";
+import Dispatcher from './dispatcher'
 
-export default RetryHandler;
+export default RetryHandler
 
-declare class RetryHandler implements Dispatcher.DispatchHandlers {
-  constructor(
+declare class RetryHandler implements Dispatcher.DispatchHandler {
+  constructor (
     options: Dispatcher.DispatchOptions & {
       retryOptions?: RetryHandler.RetryOptions;
     },
     retryHandlers: RetryHandler.RetryHandlers
-  );
+  )
 }
 
 declare namespace RetryHandler {
-  export type RetryState = { counter: number; };
+  export type RetryState = { counter: number; }
 
   export type RetryContext = {
     state: RetryState;
@@ -21,7 +21,7 @@ declare namespace RetryHandler {
     };
   }
 
-  export type OnRetryCallback = (result?: Error | null) => void;
+  export type OnRetryCallback = (result?: Error | null) => void
 
   export type RetryCallback = (
     err: Error,
@@ -32,7 +32,7 @@ declare namespace RetryHandler {
       };
     },
     callback: OnRetryCallback
-  ) => number | null;
+  ) => void
 
   export interface RetryOptions {
     /**
@@ -110,7 +110,7 @@ declare namespace RetryHandler {
   }
 
   export interface RetryHandlers {
-    dispatch: Dispatcher["dispatch"];
-    handler: Dispatcher.DispatchHandlers;
+    dispatch: Dispatcher['dispatch'];
+    handler: Dispatcher.DispatchHandler;
   }
 }

package/util.d.ts

@@ -3,7 +3,7 @@ export namespace util {
    * Retrieves a header name and returns its lowercase value.
    * @param value Header name
    */
-  export function headerNameToString(value: string | Buffer): string;
+  export function headerNameToString (value: string | Buffer): string
 
   /**
    * Receives a header object and returns the parsed value.
@@ -11,8 +11,8 @@ export namespace util {
    * @param obj Object to specify a proxy object. Used to assign parsed values.
    * @returns If `obj` is specified, it is equivalent to `obj`.
    */
-  export function parseHeaders(
+  export function parseHeaders (
     headers: (Buffer | string | (Buffer | string)[])[],
     obj?: Record<string, string | string[]>
-  ): Record<string, string | string[]>;
+  ): Record<string, string | string[]>
 }

package/utility.d.ts

@@ -0,0 +1,7 @@
+type AutocompletePrimitiveBaseType<T> =
+  T extends string ? string :
+    T extends number ? number :
+      T extends boolean ? boolean :
+        never
+
+export type Autocomplete<T> = T | (AutocompletePrimitiveBaseType<T> & Record<never, never>)

package/webidl.d.ts

@@ -1,4 +1,5 @@
 // These types are not exported, and are only used internally
+import * as undici from './index'
 
 /**
  * Take in an unknown value and return one that is of type T
@@ -34,11 +35,24 @@ interface WebidlErrors {
   }): TypeError
 }
 
+interface WebIDLTypes {
+  UNDEFINED: 1,
+  BOOLEAN: 2,
+  STRING: 3,
+  SYMBOL: 4,
+  NUMBER: 5,
+  BIGINT: 6,
+  NULL: 7
+  OBJECT: 8
+}
+
 interface WebidlUtil {
   /**
    * @see https://tc39.es/ecma262/#sec-ecmascript-data-types-and-values
    */
-  Type (object: unknown):
+  Type (object: unknown): WebIDLTypes[keyof WebIDLTypes]
+
+  TypeValueToString (o: unknown):
     | 'Undefined'
     | 'Boolean'
     | 'String'
@@ -48,6 +62,8 @@ interface WebidlUtil {
     | 'Null'
     | 'Object'
 
+  Types: WebIDLTypes
+
   /**
    * @see https://webidl.spec.whatwg.org/#abstract-opdef-converttoint
    */
@@ -68,6 +84,8 @@ interface WebidlUtil {
    */
   Stringify (V: any): string
 
+  MakeTypeAssertion <I>(I: I): (arg: any) => arg is I
+
   /**
    * Mark a value as uncloneable for Node.js.
    * This is only effective in some newer Node.js versions.
@@ -156,7 +174,7 @@ interface WebidlConverters {
   ): NodeJS.TypedArray | ArrayBufferLike | DataView
 
   ['sequence<ByteString>']: SequenceConverter<string>
-  
+
   ['sequence<sequence<ByteString>>']: SequenceConverter<string[]>
 
   ['record<ByteString, ByteString>']: RecordConverter<string, string>
@@ -164,16 +182,35 @@ interface WebidlConverters {
   [Key: string]: (...args: any[]) => unknown
 }
 
+type IsAssertion<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>
+}
+
 export interface Webidl {
   errors: WebidlErrors
   util: WebidlUtil
   converters: WebidlConverters
+  is: WebidlIs
 
   /**
    * @description Performs a brand-check on {@param V} to ensure it is a
    * {@param cls} object.
    */
-  brandCheck <Interface>(V: unknown, cls: Interface, opts?: { strict?: boolean }): asserts V is Interface
+  brandCheck <Interface extends new () => unknown>(V: unknown, cls: Interface): asserts V is Interface
+
+  brandCheckMultiple <Interfaces extends (new () => unknown)[]> (list: Interfaces): (V: any) => asserts V is Interfaces[number]
 
   /**
    * @see https://webidl.spec.whatwg.org/#es-sequence
@@ -196,10 +233,11 @@ export interface Webidl {
    * Similar to {@link Webidl.brandCheck} but allows skipping the check if third party
    * interfaces are allowed.
    */
-  interfaceConverter <Interface>(cls: Interface): (
+  interfaceConverter <Interface>(typeCheck: IsAssertion<Interface>, name: string): (
     V: unknown,
-    opts?: { strict: boolean }
-  ) => asserts V is typeof cls
+    prefix: string,
+    argument: string
+  ) => asserts V is Interface
 
   // TODO(@KhafraDev): a type could likely be implemented that can infer the return type
   // from the converters given?

package/websocket.d.ts

@@ -22,7 +22,7 @@ interface WebSocketEventMap {
 
 interface WebSocket extends EventTarget {
   binaryType: BinaryType
-  
+
   readonly bufferedAmount: number
   readonly extensions: string
 
@@ -148,3 +148,36 @@ interface WebSocketInit {
   dispatcher?: Dispatcher,
   headers?: HeadersInit
 }
+
+interface WebSocketStreamOptions {
+  protocols?: string | string[]
+  signal?: AbortSignal
+}
+
+interface WebSocketCloseInfo {
+  closeCode: number
+  reason: string
+}
+
+interface WebSocketStream {
+  closed: Promise<WebSocketCloseInfo>
+  opened: Promise<{
+    extensions: string
+    protocol: string
+    readable: ReadableStream
+    writable: WritableStream
+  }>
+  url: string
+}
+
+export declare const WebSocketStream: {
+  prototype: WebSocketStream
+  new (url: string | URL, options?: WebSocketStreamOptions): WebSocketStream
+}
+
+interface WebSocketError extends Event, WebSocketCloseInfo {}
+
+export declare const WebSocketError: {
+  prototype: WebSocketError
+  new (type: string, init?: WebSocketCloseInfo): WebSocketError
+}

package/file.d.ts

@@ -1,39 +0,0 @@
-// Based on https://github.com/octet-stream/form-data/blob/2d0f0dc371517444ce1f22cdde13f51995d0953a/lib/File.ts (MIT)
-/// <reference types="node" />
-
-import { Blob } from 'buffer'
-
-export interface BlobPropertyBag {
-  type?: string
-  endings?: 'native' | 'transparent'
-}
-
-export interface FilePropertyBag extends BlobPropertyBag {
-  /**
-   * The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
-   */
-  lastModified?: number
-}
-
-export declare class File extends Blob {
-  /**
-   * Creates a new File instance.
-   *
-   * @param fileBits An `Array` strings, or [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), [`ArrayBufferView`](https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView), [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) objects, or a mix of any of such objects, that will be put inside the [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File).
-   * @param fileName The name of the file.
-   * @param options An options object containing optional attributes for the file.
-   */
-  constructor(fileBits: ReadonlyArray<string | NodeJS.ArrayBufferView | Blob>, fileName: string, options?: FilePropertyBag)
-
-  /**
-   * Name of the file referenced by the File object.
-   */
-  readonly name: string
-
-  /**
-   * The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
-   */
-  readonly lastModified: number
-
-  readonly [Symbol.toStringTag]: string
-}

package/filereader.d.ts

@@ -1,54 +0,0 @@
-/// <reference types="node" />
-
-import { Blob } from 'buffer'
-import { DOMException, EventInit } from './patch'
-
-export declare class FileReader {
-  __proto__: EventTarget & FileReader
-
-  constructor ()
-
-  readAsArrayBuffer (blob: Blob): void
-  readAsBinaryString (blob: Blob): void
-  readAsText (blob: Blob, encoding?: string): void
-  readAsDataURL (blob: Blob): void
-
-  abort (): void
-
-  static readonly EMPTY = 0
-  static readonly LOADING = 1
-  static readonly DONE = 2
-
-  readonly EMPTY = 0
-  readonly LOADING = 1
-  readonly DONE = 2
-
-  readonly readyState: number
-
-  readonly result: string | ArrayBuffer | null
-
-  readonly error: DOMException | null
-
-  onloadstart: null | ((this: FileReader, event: ProgressEvent) => void)
-  onprogress: null | ((this: FileReader, event: ProgressEvent) => void)
-  onload: null | ((this: FileReader, event: ProgressEvent) => void)
-  onabort: null |  ((this: FileReader, event: ProgressEvent) => void)
-  onerror: null | ((this: FileReader, event: ProgressEvent) => void)
-  onloadend: null | ((this: FileReader, event: ProgressEvent) => void)
-}
-
-export interface ProgressEventInit extends EventInit {
-  lengthComputable?: boolean
-  loaded?: number
-  total?: number
-}
-
-export declare class ProgressEvent {
-  __proto__: Event & ProgressEvent
-
-  constructor (type: string, eventInitDict?: ProgressEventInit)
-
-  readonly lengthComputable: boolean
-  readonly loaded: number
-  readonly total: number
-}