Class ZipEntry

constructor

• new ZipEntry(): ZipEntry

  Returns ZipEntry

children

Optionaldata

id

name

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