wretch
    Preparing search index...

    Interface ProgressAddon

    interface ProgressAddon {
        onDownload<T extends ProgressAddon, C, R, E>(
            this: T & Wretch<T, C, R, E>,
            onDownload: (loaded: number, total: number) => void,
        ): this;
        onUpload<T extends ProgressAddon, C, R, E>(
            this: T & Wretch<T, C, R, E>,
            onUpload: (loaded: number, total: number) => void,
        ): this;
    }
    Index

    Methods

    onDownload onUpload

    Methods

    • Provides a way to register a callback to be invoked one or multiple times during the download. The callback receives the current progress as two arguments, the number of bytes downloaded and the total number of bytes to download.

      Compatible with all platforms implementing the TransformStream WebAPI.

      import ProgressAddon from "wretch/addons/progress"

      wretch("some_url")
        .addon(ProgressAddon())
        .onDownload((loaded, total) => console.log(`Download: ${(loaded / total * 100).toFixed(0)}%`))
        .get()
        .res()

      Type Parameters

      Parameters

      • this: T & Wretch<T, C, R, E>
      • onDownload: (loaded: number, total: number) => void

        A callback that will be called one or multiple times with the number of bytes downloaded and the total number of bytes to download.

      Returns this

    • Provides a way to register a callback to be invoked one or multiple times during the upload. The callback receives the current progress as two arguments, the number of bytes uploaded and the total number of bytes to upload.

      Browser Limitations:

      • Firefox: Does not support request body streaming (request.body is not readable). Upload progress monitoring will not work.
      • Chrome/Chromium: Requires HTTPS connections (HTTP/2). Will fail with ERR_ALPN_NEGOTIATION_FAILED on HTTP servers.
      • Node.js: Full support for both HTTP and HTTPS.

      Compatible with platforms implementing the TransformStream WebAPI and supporting request body streaming.

      import ProgressAddon from "wretch/addons/progress"

      wretch("https://example.com/upload") // Note: HTTPS required for Chrome
        .addon(ProgressAddon())
        .onUpload((loaded, total) => console.log(`Upload: ${(loaded / total * 100).toFixed(0)}%`))
        .post(formData)
        .res()

      Type Parameters

      Parameters

      • this: T & Wretch<T, C, R, E>
      • onUpload: (loaded: number, total: number) => void

        A callback that will be called one or multiple times with the number of bytes uploaded and the total number of bytes to upload.

      Returns this

    Settings

    Member Visibility

    On This Page

    Methods