Endo API documentation - v0.2.0 / Exports / @endo/zip

Module: @endo/zip

Table of contents

Classes

• ZipReader
• ZipWriter

Interfaces

• ArchiveReader
• ArchiveWriter

Type Aliases

• ArchiveHeaders
• ArchivedFile
• ArchivedStat
• CompressedFile
• ReadFn
• SnapshotFn
• UncompressedFile
• WriteFn

Functions

• readZip
• writeZip

Type Aliases

ArchiveHeaders

Ƭ ArchiveHeaders: Object

Type declaration

Name	Type
bitFlag	number
compressedLength	number
compressionMethod	number
crc32	number
date	Date | null
uncompressedLength	number
versionNeeded	number

Defined in

src/types.js:46

---

ArchivedFile

Ƭ ArchivedFile: { content: Uint8Array ; name: string } & ArchivedStat

Defined in

src/types.js:16

---

ArchivedStat

Ƭ ArchivedStat: Object

Type declaration

Name	Type
comment	string
date	Date | null
mode	number
type	"file" | "directory"

Defined in

src/types.js:11

---

CompressedFile

Ƭ CompressedFile: Object

Type declaration

Name	Type
comment	Uint8Array
compressedLength	number
compressionMethod	number
content	Uint8Array
crc32	number
date	Date | null
mode	number
name	Uint8Array
uncompressedLength	number

Defined in

src/types.js:36

---

ReadFn

Ƭ ReadFn: (name: string) => Promise<Uint8Array>

Type declaration

▸ (name): Promise<Uint8Array>

Parameters

Name	Type
name	string

Returns

Promise<Uint8Array>

Defined in

src/types.js:55

---

SnapshotFn

Ƭ SnapshotFn: () => Promise<Uint8Array>

Type declaration

▸ (): Promise<Uint8Array>

Returns

Promise<Uint8Array>

Defined in

src/types.js:74

---

UncompressedFile

Ƭ UncompressedFile: Object

Type declaration

Name	Type
comment	Uint8Array
content	Uint8Array
date	Date | null
mode	number
name	Uint8Array

Defined in

src/types.js:24

---

WriteFn

Ƭ WriteFn: (name: string, bytes: Uint8Array) => Promise<void>

Type declaration

▸ (name, bytes): Promise<void>

Parameters

Name	Type
name	string
bytes	Uint8Array

Returns

Promise<void>

Defined in

src/types.js:67

Functions

readZip

▸ readZip(data, location): Promise<ArchiveReader>

Parameters

Name	Type
data	Uint8Array
location	string

Returns

Promise<ArchiveReader>

Defined in

src/reader.js:54

---

writeZip

▸ writeZip(): ArchiveWriter

Returns

ArchiveWriter

Defined in

src/writer.js:55