@embra/reactivity - v0.0.7
    Preparing search index...

    Interface Writable<TValue>

    A Writable is a Readable with a writable value property and a set method that updates the value.

    interface Writable<TValue = any> {
        disposed: boolean;
        get: () => TValue;
        name?: string;
        set: (value: TValue) => void;
        value: TValue;
        version: number;
        reaction(subscriber: Subscriber<TValue>, scheduler?: Scheduler): Disposer;
        subscribe(subscriber: Subscriber<TValue>, scheduler?: Scheduler): Disposer;
        unsubscribe(
            subscriber?: (...args: any[]) => any,
            scheduler?: Scheduler,
        ): void;
    }

    Type Parameters

    • TValue = any

    Hierarchy (View Summary)

    Index

    Properties

    disposed get name? set value version

    Methods

    reaction subscribe unsubscribe

    Properties
    disposed: boolean

    Indicates whether the Readable has been disposed.

    get: () => TValue

    Get current value.

    name?: string
    set: (value: TValue) => void

    Set new value

    value: TValue

    Current value of the Writable

    version: number

    A version representation of the value. If two versions of a $ is not equal(Object.is), it means the value has changed (event if the value is equal).

    Methods

    • Remove the given subscriber or all subscribers if no subscriber is provided.

      Parameters

      • Optionalsubscriber: (...args: any[]) => any

        Optional subscriber function to remove.

      • Optionalscheduler: Scheduler

        Optional scheduler associated with the subscriber. If not provided, all subscribers will be removed.

      Returns void

    Settings

    On This Page
    Properties
    Methods