@zip.js/zip.js
    Preparing search index...

    Interface EntryDataOnprogressOptions

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

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

    Hierarchy (View Summary)

    Index

    Methods

    onend? onprogress? onstart?

    Methods

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void> | undefined

      An empty promise or undefined.

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void> | undefined

      An empty promise or undefined.

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void> | undefined

      An empty promise or undefined.

    Settings

    Member Visibility

    On This Page

    Methods