Skeudenn / main/services/comic-archive / ComicArchive

Interface: ComicArchive

Defined in: src/main/services/comic-archive.ts:14

An opened comic file, whatever its format.

Properties

fileCount

readonly fileCount: number

Defined in: src/main/services/comic-archive.ts:19

Total entries in the archive (not just image pages).

---

pages

readonly pages: readonly string[]

Defined in: src/main/services/comic-archive.ts:17

Image entry names, sorted in reading order.

---

path

readonly path: string

Defined in: src/main/services/comic-archive.ts:15

Methods

close()

close(): Promise<void>

Defined in: src/main/services/comic-archive.ts:29

Releases the underlying resources; the archive must not be used afterwards.

Returns

Promise<void>

---

pageSize()?

optional pageSize(index): Promise<ImageSize | null>

Defined in: src/main/services/comic-archive.ts:27

Size in pixels of page index, when the archive can tell without reading the whole page (a PDF knows it from the page's box). Absent for the formats whose pages are image files: the measure then reads their headers.

Parameters

index

number

Returns

Promise<ImageSize | null>

---

readPage()

readPage(index): Promise<ComicPage>

Defined in: src/main/services/comic-archive.ts:21

Reads page index (0-based, in pages order); rejects with a RangeError when out of range.

Parameters

index

number

Returns

Promise<ComicPage>