Class TlDrawSyncedStorage<T>

The TlDrawSyncedStorage class manages synchronized storage for drawing states using Y.js and y-websocket.

Type Parameters

T extends SyncedStorageState
Type parameter extending from SyncedStorageState, represents the state structure.

Index

Constructors

Properties

doc provider state

Accessors

Methods

deleteState dispose getState initializeState onStateChanged onStateOff setState

Constructors

constructor

new TlDrawSyncedStorage<T>(roomId, initialState, serverUrl): TlDrawSyncedStorage<T>
Constructs an instance of TlDrawSyncedStorage.
Type Parameters
- T extends SyncedStorageState
Parameters
- roomId: string
  The identifier for the room, used for data segregation.
- initialState: T
  The initial state to populate the storage with.
- serverUrl: string
  The URL of the WebSocket server.
Returns TlDrawSyncedStorage<T>
- Defined in tldraw-synced.ts:30

Properties

doc

doc: Doc

provider

provider: WebsocketProvider

state

state: YKeyValue<T>

Accessors

room

get room(): WebsocketProvider
Gets the WebSocket provider associated with this storage.

Returns WebsocketProvider
The WebsocketProvider instance.
- Defined in tldraw-synced.ts:46

Methods

deleteState

deleteState(newState): void
Deletes parts of the state based on the provided newState object.
Parameters
- newState: Partial<T>
  The state changes to apply, specifying the keys to delete.
Returns void
- Defined in tldraw-synced.ts:77

dispose

dispose(): void
Disconnects and disposes of the resources used by this TlDrawSyncedStorage instance.

Returns void
- Defined in tldraw-synced.ts:190

getState

getState(): any[]
Retrieves the current state as an array.

Returns any[]
An array representing the current state.
- Defined in tldraw-synced.ts:68

initializeState

initializeState(initialState): void
Initializes the storage with the provided initial state.
Parameters
- initialState: T
  The initial state to set.
Returns void
- Defined in tldraw-synced.ts:55

onStateChanged

onStateChanged(callback): void
Registers a callback to be called when the state changes.
Parameters
- callback: ((diff, transaction) => void)
  The function to be called with the changes and transaction when the state changes.
  - - (diff, transaction): void
    - Parameters
      diff: SyncedStorageDiff<T>
      transaction: Transaction
      Returns void
Returns void
- Defined in tldraw-synced.ts:108

onStateOff

onStateOff(callback): void
Unregisters a callback from being called when the state changes.
Parameters
- callback: ((diff, transaction) => void)
  The callback function to unregister.
  - - (diff, transaction): void
    - Parameters
      diff: SyncedStorageDiff<T>
      transaction: Transaction
      Returns void
Returns void
- Defined in tldraw-synced.ts:150

setState

setState(newState): void
Sets the state based on the provided newState object.
Parameters
- newState: Partial<T>
  The new state to apply.
Returns void
- Defined in tldraw-synced.ts:89

Generated using TypeDoc