@tldraw/store

Documentation

Usage

API

`RecordStore`

`put(records: R[]): void`

`update(id: ID, updater: (record: R) => R): void`

`remove(ids: ID[]): void`

`get(id: ID): R`

`allRecords(): R[]`

`clear(): void`

`has(id: ID): boolean`

`serialize(filter?: (record: R) => boolean): RecordStoreSnapshot`

`deserialize(snapshot: RecordStoreSnapshot): void`

`listen(listener: ((entry: HistoryEntry) => void): () => void`

`mergeRemoteChanges(fn: () => void): void`

`createDerivationCache(name: string, derive: ((record: R) => R | undefined)): DerivationCache`

`RecordType`

`create(properties: Pick & Omit, RequiredProperties>): R`

`clone(record: R): R`

`createId(): ID`

`createId(id: string): ID`

`isInstance`

`isId`

`withDefaultProperties`

`RecordStoreQueries`

Helpers

`executeQuery`

`DerivationCache`

`createRecordType`

`assertIdType`

Types

`ID`

`BaseRecord`

`RecordsDiff`

`CollectionDiff`

Contribution

License

Trademarks

Contact

Community