Interface ZipWriterCloseOptions

Represents the options passed to ZipWriter#close.

interface ZipWriterCloseOptions {
    preventClose?: boolean;
    zip64?: boolean;
    onprogress?(progress: number, total: number, entry: EntryMetaData): Promise<void>;
}

Hierarchy (view full)

Properties

preventClose? zip64?

Methods

onprogress?

Properties

OptionalpreventClose

preventClose?: boolean

true to prevent closing of WritableWriter#writable.

Default Value

false

Optionalzip64

zip64?: boolean

true to use Zip64 to write the entries directory.

Default Value

false

Methods

Optionalonprogress

  • 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.

Settings

Member Visibility

On This Page

Properties
Methods