Class default<T>

Interface for implementing your own state

Type Parameters

Hierarchy

default<T>
- default

Index

Constructors

constructor

new default<T>(valueFactory, updateNow?): default<T>
Creates a new PollingModelState
Type Parameters
- T
Parameters
- valueFactory: (() => T)
  can be a value factory
  - - (): T
    - Returns T
- Optional updateNow: boolean
Returns default<T>
Overrides default.constructor
- Defined in src/ModelState/FactoryModelState.ts:15
new default<T>(promiseFactory, updateNow?): default<T>
Creates a new PollingModelState
Type Parameters
- T
Parameters
- promiseFactory: (() => Promise<T>)
  can be a promise factory
  - - (): Promise<T>
    - Returns Promise<T>
- Optional updateNow: boolean
Returns default<T>
Overrides BaseModelState<T>.constructor
- Defined in src/ModelState/FactoryModelState.ts:20
new default<T>(promiseOrValueFactory, updateNow?): default<T>
Creates a new PollingModelState
Type Parameters
- T
Parameters
- promiseOrValueFactory: (() => Awaitable<T>)
  can be a promise or a value factory, a value or a promise that will be invoked immediately
  - - (): Awaitable<T>
    - Returns Awaitable<T>
- Optional updateNow: boolean
Returns default<T>
Overrides BaseModelState<T>.constructor
- Defined in src/ModelState/FactoryModelState.ts:25

Properties

`Private` `Optional` #currentPromise

#currentPromise?: default<void>

`Private` `Readonly` #postHandlers

#postHandlers: Record<string, EventHandler<Undefinable<T>>>

`Private` `Readonly` #preHandlers

#preHandlers: Record<string, EventHandler<Undefinable<T>>>

`Private` `Readonly` #updatedEvent

#updatedEvent: default<Undefinable<T>>

`Private` `Readonly` #updater

#updater: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

`Private` `Readonly` #updatingEvent

#updatingEvent: default<Undefinable<T>>

`Private` #value

#value: Undefinable<T>

Accessors

value

get value(): Undefinable<T>
Gets the current value of the ModelState

Returns Undefinable<T>
Overrides BaseModelState.value
- Defined in src/ModelState/FactoryModelState.ts:60
set value(value): void
Parameters
- value: Undefinable<T>
Returns void
Overrides BaseModelState.value
- Defined in src/ModelState/FactoryModelState.ts:65

Methods

`Private` `Readonly` #onUpdated

#onUpdated(): void
Invokes the subscriptions with the current value

Returns void
Inherited from default.#onUpdated
- Defined in src/ModelState/BaseModelState.ts:138

`Private` `Readonly` #onUpdating

#onUpdating(): void
Returns void
Inherited from default.#onUpdating
- Defined in src/ModelState/BaseModelState.ts:143

`Private` `Readonly` #waitForPromise

#waitForPromise(then): Promise<void> | default<void>
Parameters
- then: (() => void)
  - - (): void
    - Returns void
Returns Promise<void> | default<void>
- Defined in src/ModelState/FactoryModelState.ts:79

`Protected` getValue

getValue(): Undefinable<T>
Returns Undefinable<T>
Inherited from default.getValue
- Defined in src/ModelState/BaseModelState.ts:125

`Protected` setValue

setValue(value): void
Parameters
- value: Undefinable<T>
Returns void
Inherited from default.setValue
- Defined in src/ModelState/BaseModelState.ts:130

subscribe(postCallback, preCallback?): string
Creates a subscription to the ModelState that will be called when the state is updated.
Parameters
- postCallback: ((value) => void)
  - - (value): void
    - Parameters
      value: Undefinable<T>
      Returns void
- Optional preCallback: ((value) => void)
  - - (value): void
    - Parameters
      value: Undefinable<T>
      Returns void
Returns string
A symbol that must saved to unsubscribe from the ModelState
Overrides default.subscribe
- Defined in src/ModelState/FactoryModelState.ts:41

`Protected` subscribeCore

subscribeCore(postCallback, preCallback?, publishCurrentValue?): string
Parameters
- postCallback: ((value) => void)
  - - (value): void
    - Parameters
      value: Undefinable<T>
      Returns void
- Optional preCallback: ((value) => void)
  - - (value): void
    - Parameters
      value: Undefinable<T>
      Returns void
- publishCurrentValue: boolean = true
Returns string
Inherited from default.subscribeCore
- Defined in src/ModelState/BaseModelState.ts:102

toPromise

toPromise(): Promise<Undefinable<T>>
Returns the ModelState as a Promise

Returns Promise<Undefinable<T>>
Inherited from default.toPromise
- Defined in src/ModelState/BaseModelState.ts:80

toString

toString(): string
Returns the string version of the ModelState value

Returns string
Inherited from default.toString
- Defined in src/ModelState/BaseModelState.ts:74

unsubscribe

unsubscribe(key): void
Unsubscribes a component from the model state.
Parameters
- key: string
  The symbol that was returned from the subscribe method.
Returns void
Inherited from default.unsubscribe
- Defined in src/ModelState/BaseModelState.ts:44

update

update(): void
Returns void
- Defined in src/ModelState/FactoryModelState.ts:70

valueOf

valueOf(): Undefinable<T>
Returns the current value of the ModelState

Returns Undefinable<T>
Inherited from default.valueOf
- Defined in src/ModelState/BaseModelState.ts:68

Class default<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

valueFactory: (() => T)

Returns T

Optional updateNow: boolean

Returns default<T>

Type Parameters

T

Parameters

promiseFactory: (() => Promise<T>)

Returns Promise<T>

Optional updateNow: boolean

Returns default<T>

Type Parameters

T

Parameters

promiseOrValueFactory: (() => Awaitable<T>)

Returns Awaitable<T>

Optional updateNow: boolean

Returns default<T>

Properties

Private Optional #currentPromise

Private Readonly #postHandlers

Private Readonly #preHandlers

Private Readonly #updatedEvent

Private Readonly #updater

Type declaration

Returns Promise<void>

Private Readonly #updatingEvent

Private #value

Accessors

value

Returns Undefinable<T>

Parameters

value: Undefinable<T>

Returns void

Methods

Private Readonly #onUpdated

Returns void

Private Readonly #onUpdating

Returns void

Private Readonly #waitForPromise

Parameters

then: (() => void)

Returns void

Returns Promise<void> | default<void>

Protected getValue

Returns Undefinable<T>

Protected setValue

Parameters

value: Undefinable<T>

Returns void

subscribe

Parameters

postCallback: ((value) => void)

Parameters

value: Undefinable<T>

Returns void

Optional preCallback: ((value) => void)

Parameters

value: Undefinable<T>

Returns void

Returns string

Protected subscribeCore

Parameters

postCallback: ((value) => void)

Parameters

value: Undefinable<T>

`Optional` updateNow: boolean

`Optional` updateNow: boolean

`Optional` updateNow: boolean

`Private` `Optional` #currentPromise

`Private` `Readonly` #postHandlers

`Private` `Readonly` #preHandlers

`Private` `Readonly` #updatedEvent

`Private` `Readonly` #updater

`Private` `Readonly` #updatingEvent

`Private` #value

`Private` `Readonly` #onUpdated

`Private` `Readonly` #onUpdating

`Private` `Readonly` #waitForPromise

`Protected` getValue

`Protected` setValue

`Optional` preCallback: ((value) => void)

`Protected` subscribeCore

`Optional` preCallback: ((value) => void)