Class Zip

Hierarchy

Zip
- FileZip
- PartialZip

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Zip(pathOrUrl: string): Zip

- Defined in lib/base/Zip.ts:25
Parameters
- pathOrUrl: string
Returns Zip

Properties

Optional eocd

eocd: EOCD

EOCD

Optional eocd64

eocd64: EOCD64

EOCD64

Optional eocd64Locator

eocd64Locator: EOCD64Locator

EOCD64 Locator

files

files: Map<string, CentralDirectoryEntry> = new Map()

Central Directory Entries

Protected path

path: string

Path/URL of Zip file

Protected size

size: number = -1

Zip size

Methods

get

get(entry: CentralDirectoryEntry, checkIntegrity?: boolean): Promise<Buffer>

- Defined in lib/base/Zip.ts:52
Parameters
- entry: CentralDirectoryEntry
- Default value checkIntegrity: boolean = false
Returns Promise<Buffer>

Protected getCentralDir

getCentralDir(): Promise<void>

- Defined in lib/base/Zip.ts:141
Returns Promise<void>

Protected getEocd

getEocd(): Promise<void>

- Defined in lib/base/Zip.ts:125
Returns Promise<void>

init

init(): Promise<void>

- Defined in lib/base/Zip.ts:46
Returns Promise<void>

Abstract partialGet

partialGet(start: number | bigint, end: number | bigint): Promise<Buffer>

- Defined in lib/base/Zip.ts:37
Downloads part of a file from a url.

Parameters
- start: number | bigint
  
  start byte offset to get
- end: number | bigint
  
  end byte offset to get
Returns Promise<Buffer>

Protected Abstract preInit

preInit(): Promise<void>

- Defined in lib/base/Zip.ts:43
Any initialization needed like checking for partial download support and file size initialization.

Returns Promise<void>

Generated using TypeDoc