Class StoragePropertySet

constructor

• new StoragePropertySet(
      properties?: StorageProperty<StorageTypes>[],
  ): StoragePropertySet

  Contains a set of StorageProperties.

  Parameters

  • Optionalproperties: StorageProperty<StorageTypes>[]

    Storage properties to add to the StoragePropertySet

  Returns StoragePropertySet

storageProperties

addProperty

• addProperty<T extends StorageTypes>(
      property: StorageProperty<T>,
  ): StorageProperty<T>

  Add a property to the set. If a property already exists with the same key, this property's key will have a number appended to avoid collision, and a warning will be printed.

  Type Parameters

  • T extends StorageTypes

  Parameters

  • property: StorageProperty<T>

    StorageProperty to add

  Returns StorageProperty<T>

  StorageProperty passed in

applyKeyUpdate

• applyKeyUpdate<T extends StorageTypes>(
      store: GeneralDataStore,
      key: string,
      intialValue?: boolean,
      dontTriggerEvents?: boolean,
      updateInfo?: RealtimeStoreUpdateInfo,
  ): void

  Type Parameters

  • T extends StorageTypes

  Parameters

  • store: GeneralDataStore

    The data store to apply the update to.
  • key: string

    The key to apply the update to.
  • OptionalintialValue: boolean

    The initial value to apply.
  • OptionaldontTriggerEvents: boolean

    If true, events will not be triggered.
  • OptionalupdateInfo: RealtimeStoreUpdateInfo

    Information about the update.

  Returns void

forceWriteState

• forceWriteState(store: GeneralDataStore): void

  Parameters

  • store: GeneralDataStore

    The data store to apply the update to.

  Returns void

getProperty

• getProperty<T extends StorageTypes>(propertyKey: string): StorageProperty<T>

  Returns the storage property in this set with a matching propertyKey, or null if none is found.

  Type Parameters

  • T extends StorageTypes

  Parameters

  • propertyKey: string

    propertyKey to search for

  Returns StorageProperty<T>

  StorageProperty with a matching key, or null if none is found

initializeFromStore

• initializeFromStore(store: GeneralDataStore, dontTriggerEvents?: boolean): void

  Parameters

  • store: GeneralDataStore

    The data store to initialize from.
  • OptionaldontTriggerEvents: boolean

    If true, events will not be triggered.

  Returns void

receiveChanges

• receiveChanges(): void

  Receives changes from the store for all storage properties in the set.

  Returns void

sendAndReceiveChanges

• sendAndReceiveChanges(store: GeneralDataStore, serverTime: number): boolean

  Sends and receives changes for all storage properties in the set.

  Parameters

  • store: GeneralDataStore

    The data store to send and receive the changes.
  • serverTime: number

    The current server time.

  Returns boolean

  True if any changes were sent, false otherwise.

sendChanges

• sendChanges(store: GeneralDataStore, serverTime: number): boolean

  Sends changes to the store for all storage properties in the set.

  Parameters

  • store: GeneralDataStore

    The data store to send the changes to.
  • serverTime: number

  Returns boolean

  True if any changes were sent, false otherwise.