Interface WritableSignal<T, U>

Represents a store that implements both ReadableSignal and Writable. This is the type of objects returned by writable.

interface WritableSignal<T, U> {
    [observable](): Readable<T>;
    set(value): void;
    subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject;
    update(updater): void;
    (): T;
}

Type Parameters

T
U = T

Hierarchy (view full)

ReadableSignal<T>
Writable<T, U>
- WritableSignal

WritableSignal(): T
Returns the value of the store. This is a shortcut for calling get with the store.

Returns T
- Defined in index.ts:178

Index

Methods

[observable] set subscribe update

Methods

[observable]

[observable](): Readable<T>
Returns Readable<T>
Inherited from Writable.[observable]
- Defined in index.ts:129

set

set(value): void
Replaces store's state with the provided value.
Parameters
- value: U
  value to be used as the new state of a store.
Returns void
Inherited from Writable.set
- Defined in index.ts:165

subscribe

subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. It is called each and every time the store's value changes.

A registered subscriber is notified synchronously with the latest store value.
Parameters
- subscriber: Subscriber<T>
  a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the unsubscribe method) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
Inherited from Writable.subscribe
- Defined in index.ts:128

update

update(updater): void
Updates store's state by using an Updater function.
Parameters
- updater: Updater<T, U>
  a function that takes the current state as an argument and returns the new state.
Returns void
Inherited from Writable.update
- Defined in index.ts:171

Generated using TypeDoc