cupertino-files / IWorkContainer

Class: IWorkContainer

Defined in: src/tsp/package.ts:37

Constructors

Constructor

new IWorkContainer(): IWorkContainer

Returns

IWorkContainer

Properties

iwaFiles

readonly iwaFiles: Map<string, Uint8Array<ArrayBufferLike>>

Defined in: src/tsp/package.ts:47

Canonical IWA path (e.g. "Index/Document.iwa") → file bytes.

---

prefix

prefix: string = ""

Defined in: src/tsp/package.ts:41

Common wrapper-directory prefix, e.g. "Project Proposal.pages/" or "".

Accessors

layout

Get Signature

get layout(): "flat" | "nested-index-zip" | "wrapper-directory"

Defined in: src/tsp/package.ts:50

How this package was laid out on disk (preserved on save).

Returns

"flat" | "nested-index-zip" | "wrapper-directory"

Methods

otherFiles()

otherFiles(): Map<string, Uint8Array<ArrayBufferLike>>

Defined in: src/tsp/package.ts:127

Non-IWA entries (canonical relative name → bytes), e.g. Metadata/, Data/.

Returns

Map<string, Uint8Array<ArrayBufferLike>>

---

toBytes()

toBytes(replacements, additions?): Uint8Array

Defined in: src/tsp/package.ts:144

Rebuild the package, substituting the given IWA files (canonical name → new bytes). Preserves layout, entry order, timestamps and all non-IWA bytes; appends entries for canonical names that did not previously exist. additions adds arbitrary non-IWA files (e.g. Data/ media) at the package level, next to the existing Metadata/Data entries.

Parameters

replacements

ReadonlyMap<string, Uint8Array<ArrayBufferLike>>

additions?

ReadonlyMap<string, Uint8Array<ArrayBufferLike>> = ...

Returns

Uint8Array

---

fromBytes()

static fromBytes(bytes): IWorkContainer

Defined in: src/tsp/package.ts:55

Parameters

bytes

Uint8Array

Returns

IWorkContainer