Interface WatchableState<T>

A Watchable encapsulating a changing value which you can write and read.

Type Parameters

T

The value stored, retrieved and watched.

Hierarchy

Watchable<T>
- WatchableState

Implemented by

Index

Properties

read watch write

Properties

read

read: (() => T)

Type declaration

- (): T
- Retrieve the current state.
  
  Returns T

watch

watch: ((watcher) => Unwatch)

Type declaration

- (watcher): Unwatch
- Subscribes watcher to receive notifications.
  Parameters
  - watcher: Watcher<T>
    
    The subscribed function.
  Returns Unwatch
  - a callback for unsubscribing

write

write: ((state) => T)

Type declaration

- (state): T
- Store a new state.
  Parameters
  - state: T
  Returns T

Generated using TypeDoc