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 full)

EntryOnprogressOptions
- ZipReaderGetEntriesOptions
- ZipWriterCloseOptions

Index

Methods

Methods

`Optional`onprogress

onprogress(progress, total, entry): 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.
- Defined in index.d.ts:1436