Interface EntryOnprogressOptions

Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.

interface EntryOnprogressOptions {
    onprogress(
        progress: number,
        total: number,
        entry: EntryMetaData,
    ): Promise<void>;
}

Hierarchy (View Summary)

Methods

onprogress?

Methods

Optionalonprogress

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

  • The function called each time an entry is read/written.

    Parameters

    • progress: number

      The entry index.

    • total: number

      The total number of entries.

    • entry: EntryMetaData

      The entry being read/written.

    Returns Promise<void>

    An empty promise or undefined.

Settings

Member Visibility

On This Page

Methods