Class DefaultWatchableState<State>

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

Type Parameters

State

The value stored, retrieved and watched.

Hierarchy

DefaultWatchable<State>
- DefaultWatchableState

Implements

WatchableState<State>

Index

Constructors

Properties

Methods

notify read watch write

Constructors

constructor

new DefaultWatchableState<State>(value, watchers?): DefaultWatchableState<State>
Type Parameters
- State
Parameters
- value: State
- Optional watchers: readonly Watcher<State>[]
Returns DefaultWatchableState<State>
Overrides DefaultWatchable<State>.constructor
- Defined in lib/watchableState.ts:9

Properties

`Protected` value

value: State

`Protected` watchers

watchers: readonly Watcher<State>[]

Methods

`Protected` notify

notify(item): Promise<void>
Parameters
- item: Value
Returns Promise<void>
Inherited from DefaultWatchable.notify
- Defined in lib/watchable.ts:9

read

read(): State
Retrieve the current state.

Returns State
Implementation of WatchableState.read
- Defined in lib/watchableState.ts:20

watch

watch(watcher): (() => void)
Subscribes watcher to receive notifications.
Parameters
- watcher: Watcher<Value>
  
  The subscribed function.
Returns (() => void)
- a callback for unsubscribing
- - (): void
  - Returns void
Implementation of WatchableState.watch

Inherited from DefaultWatchable.watch
- Defined in lib/watchable.ts:17

write

write(value): State
Store a new state.
Parameters
- value: State
Returns State
Implementation of WatchableState.write
- Defined in lib/watchableState.ts:14

Generated using TypeDoc