Interface Writable<T>

Writable interface for both updating and subscribing.

interface Writable<T> {
    set(this: void, value: T): void;
    subscribe(
        this: void,
        run: Subscriber<T>,
        invalidate?: () => void,
    ): Unsubscriber;
    update(this: void, updater: Updater<T>): void;
}

Type Parameters

T

Hierarchy (View Summary)

Readable<T>
- Writable

Index

Methods

set subscribe update

Methods

set

set(this: void, value: T): void
Set value and inform subscribers.
Parameters
- this: void
- value: T
  to set
Returns void

subscribe(this: void, run: Subscriber<T>, invalidate?: () => void): Unsubscriber
Subscribe on value changes.
Parameters
- this: void
- run: Subscriber<T>
  subscription callback
- Optionalinvalidate: () => void
  cleanup callback
Returns Unsubscriber
Inherited from Readable.subscribe

update

update(this: void, updater: Updater<T>): void
Update value using callback and inform subscribers.
Parameters
- this: void
- updater: Updater<T>
  callback
Returns void