cupertino-files / Component

Class: Component

Defined in: src/tsp/store.ts:67

Constructors

Constructor

new Component(name, bytes?): Component

Defined in: src/tsp/store.ts:90

Parameters

name

string

bytes?

Uint8Array<ArrayBufferLike>

Returns

Component

Properties

byId

readonly byId: Map<bigint, IwaObject>

Defined in: src/tsp/store.ts:73

---

framing

readonly framing: IwaFraming

Defined in: src/tsp/store.ts:87

Set when the component could not be decoded — its bytes are still preserved verbatim on save, but its objects are not available.

Collaboration-mode documents are the real case: they write Index/OperationStorage.iwa with Apple LZFSE framing while every other component uses normal Snappy chunking. Failing the whole document over one such component would lose the many that parse fine.

---

loadError

readonly loadError: Error | undefined

Defined in: src/tsp/store.ts:88

---

locator

readonly locator: string

Defined in: src/tsp/store.ts:71

TSP locator form, e.g. "Document" or "Tables/DataList-5".

---

name

readonly name: string

Defined in: src/tsp/store.ts:69

Canonical zip path, e.g. "Index/Document.iwa".

---

objects

objects: IwaObject[]

Defined in: src/tsp/store.ts:72

---

structurallyDirty

structurallyDirty: boolean = false

Defined in: src/tsp/store.ts:76

Set when objects were added/removed (not just edited in place).

Accessors

dirty

Get Signature

get dirty(): boolean

Defined in: src/tsp/store.ts:122

Returns

boolean

---

isOpaque

Get Signature

get isOpaque(): boolean

Defined in: src/tsp/store.ts:118

True when this component's objects could not be read.

Returns

boolean

Methods

serialize()

serialize(): Uint8Array

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

Returns

Uint8Array