Interface EntryDataOnprogressOptions

Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.

interface EntryDataOnprogressOptions {
    onend(computedSize: number): Promise<void>;
    onprogress(progress: number, total: number): Promise<void>;
    onstart(total: number): Promise<void>;
}

Hierarchy (View Summary)

Methods

onend? onprogress? onstart?

Methods

Optionalonend

  • onend(computedSize: number): Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns Promise<void>

    An empty promise or undefined.

Optionalonprogress

  • onprogress(progress: number, total: number): Promise<void>

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

Optionalonstart

  • onstart(total: number): Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

Settings

Member Visibility

On This Page

Methods