Class Storage<T>

The Storage class manages and synchronizes state within a Y.Doc.

Type Parameters

T extends SyncedStorageState
Type parameter extending from SyncedStorageState.

Index

Constructors

Properties

_state doc initialState listeners roomId storageId

Accessors

Methods

deleteState emit getState handleStateChange initializeState off on resetState setState

Constructors

constructor

new Storage<T>(doc, roomId, storageId, initialState): Storage<T>
Initializes a new instance of the Storage class with a Y.Doc instance, a room identifier, and an initial state.
Type Parameters
- T extends SyncedStorageState
Parameters
- doc: Doc
  The Y.Doc instance for state synchronization.
- roomId: string
  The identifier for the room, used in state syncing.
- storageId: string
  The identifier for the storage, used in state syncing.
- initialState: T
  The initial state of the storage.
Returns Storage<T>
- Defined in storage.ts:26

Properties

`Private` _state

_state: YMap<T>

`Private` doc

doc: Doc

The Y.Doc instance for state synchronization.

`Private` initialState

initialState: T

The initial state of the storage.

`Private` listeners

listeners: {
[event: string]: Function[];
} = {}

Type declaration

[event: string]: Function[]

`Private` roomId

roomId: string

The identifier for the room, used in state syncing.

`Private` storageId

storageId: string

The identifier for the storage, used in state syncing.

Accessors

state

get state(): T
Gets the current state.

Returns T
- Defined in storage.ts:41

Methods

deleteState

deleteState(given): void
Deletes a given key or state from the synced storage.
Parameters
- given: Partial<T> | keyof T
  The key (as a keyof T) or state (as Partial) to delete.
Returns void
Example1
By key: // state: { ban: false, id: "shape:xxxx" } // given: "ban" => state: { id: "shape:xxxx" }

Example2
By state: // state: { ban: false, id: "shape:xxxx" } // given: { ban: true } => state: { id: "shape:xxxx" }
- Defined in storage.ts:107

`Private` emit

emit(event, ...args): void
Emits an event with the given arguments.
Parameters
- event: string
  The event name to emit.
- Rest ...args: any[]
  Arguments to be passed to the event listeners.
Returns void
- Defined in storage.ts:158

getState

getState(): T
Retrieves the current state.

Returns T
The current state as an instance of T.
- Defined in storage.ts:63

`Private` handleStateChange

handleStateChange(event): void
Handles state changes and emits a stateChanged event.
Parameters
- event: YMapEvent<T>
  The YMapEvent object.
Returns void
- Defined in storage.ts:169

initializeState

initializeState(initialState): void
Initializes the state with the given initial state.
Parameters
- initialState: T
  The initial state to be set.
Returns void
- Defined in storage.ts:50

off

off(event, listener): void
Removes a listener for an event.
Parameters
- event: string
  The event name.
- listener: Function
  The listener function to remove.
Returns void
- Defined in storage.ts:146

on

on(event, listener): (() => void)
Adds a listener for an event.
Parameters
- event: string
  The event name to listen for.
- listener: Function
  The function to be called when the event is emitted.
Returns (() => void)
A function to remove the listener.
- - (): void
  - Returns void
- Defined in storage.ts:129

resetState

resetState(): void
Resets the state to the initial state.

Returns void
- Defined in storage.ts:89

setState

setState(newState): void
Sets the state based on the provided new state.
Parameters
- newState: Partial<T>
  A partial state object representing the new state.
Returns void
- Defined in storage.ts:78

Generated using TypeDoc