Globals

Module hooks/useSingleton

Functions

Functions

Const shouldUpdate

shouldUpdate<T>(type: T, prev: DataType<T>, next: DataType<T>): boolean

- Defined in src/hooks/useSingleton.ts:13
Function deciding whether the new value of object should cause rerender of component or not

Type parameters
- T: DataModelSingleType
Parameters
- type: T
  
  Type from DataModelSingleType
- prev: DataType<T>
  
  Last value of the object
- next: DataType<T>
  
  Current value of the object
Returns boolean

True if and only if the new value should cause rerender

Const useSingleton

useSingleton<T>(type: T): DataType<T>

- Defined in src/hooks/useSingleton.ts:27
React Hook returning current value of single-instance data objects in database. Whenever the object in database changes (according to shouldUpdate function), this hook causes rerender of calling component with current value.

Type parameters
- T: DataModelSingleType
  
  Type of requested object, from DataModelSingleType
Parameters
- type: T
Returns DataType<T>

Current value of given data type in database

Generated using TypeDoc