Class ZipEntry

constructor

• new ZipEntry(): ZipEntry

  Returns ZipEntry

children

Optionaldata

id

name

Optional Readonlyoptions

Optionalparent

uncompressedSize

checkPassword

• checkPassword(password: string, options?: EntryGetDataOptions): Promise<boolean>

  Tests the password on the entry and all children if any, returns true if the entry is not password protected

  Parameters

  • password: string
  • Optionaloptions: EntryGetDataOptions

  Returns Promise<boolean>

clone

• clone(deepClone?: boolean): ZipEntry

  Clones the entry

  Parameters

  • OptionaldeepClone: boolean

    true to clone all the descendants.

  Returns ZipEntry

getFullname

• getFullname(): string

  Returns the full filename of the entry

  Returns string

getRelativeName

• getRelativeName(ancestor: ZipDirectoryEntry): string

  Returns the filename of the entry relative to a parent directory

  Parameters

  • ancestor: ZipDirectoryEntry

  Returns string

isDescendantOf

• isDescendantOf(ancestor: ZipDirectoryEntry): boolean

  Tests if a ZipDirectoryEntry instance is an ancestor of the entry

  Parameters

  • ancestor: ZipDirectoryEntry

    The ZipDirectoryEntry instance.

  Returns boolean

isPasswordProtected

• isPasswordProtected(): boolean

  Tests if the entry or any of its children is password protected

  Returns boolean

rename

• rename(name: string): void

  Set the name of the entry

  Parameters

  • name: string

    The new name of the entry.

  Returns void

setOptions

• setOptions(options: ZipWriterAddDataOptions): void

  Sets the options applied to the entry when the zip file is exported

  Parameters

  • options: ZipWriterAddDataOptions

    The options.

  Returns void

  Remarks

  The options are merged into ZipEntry#options, and an option set to undefined is removed from it instead of being stored. They take precedence over the options passed to {@link ZipDirectoryEntry}#export*() and over the metadata of the entry they were imported from, exactly like the options passed when adding an entry to the filesystem.

  The options describing the data of an entry exported as-is, e.g. ZipWriterConstructorOptions#compressionMethod and ZipWriterAddDataOptions#uncompressedSize, are ignored: they are always the ones of the original entry. The ZipWriterAddDataOptions#directory option and the progress callbacks are ignored as well. Invalid option values are reported when the zip file is exported.