Class ZipEntry

constructor

• new ZipEntry(): ZipEntry

• Returns ZipEntry

children

Optional data

id

name

Optional parent

uncompressedSize

checkPassword

• checkPassword(password, options?): 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
  • Optional options: EntryGetDataOptions

  Returns Promise<boolean>

clone

• clone(deepClone?): ZipEntry

• Clones the entry

  Parameters

  • Optional deepClone: boolean

    true to clone all the descendants.

  Returns ZipEntry

getFullname

• getFullname(): string

• Returns the full filename of the entry

  Returns string

getRelativeName

• getRelativeName(ancestor): string

• Returns the filename of the entry relative to a parent directory

  Parameters

  • ancestor: ZipDirectoryEntry

  Returns string

isDescendantOf

• isDescendantOf(ancestor): 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): void

• Set the name of the entry

  Parameters

  • name: string

    The new name of the entry.

  Returns void