react-rv
    Preparing search index...

    Interface Rv<T>

    A reactive variable (RV) function that allows getting, setting, and subscribing to changes.

    interface Rv<T> {
        off: (listener: Listener<T>) => void;
        on: (listener: Listener<T>) => CleanupFn;
        size: () => number;
        (): T;
        (newValue: T, options?: RvOptions<T>): T;
    }

    Type Parameters

    • T

      The type of the stored value.

    • Retrieves the current value of the reactive variable.

      Returns T

      The current value of type T.

    • Updates the value of the reactive variable.

      Parameters

      • newValue: T

        The new value to set.

      • Optionaloptions: RvOptions<T>

        Optional configuration for the update.

      Returns T

      The updated value.

    Index

    Properties

    off on size

    Properties

    off: (listener: Listener<T>) => void

    Unsubscribes a listener from value changes.

    Type declaration

      • (listener: Listener<T>): void

      • Parameters

        • listener: Listener<T>

          A callback function that is needed to be unsubscribed.

        Returns void

    on: (listener: Listener<T>) => CleanupFn

    Subscribes a listener to value changes.

    Type declaration

      • (listener: Listener<T>): CleanupFn

      • Parameters

        • listener: Listener<T>

          A callback function that is triggered when the value changes.

        Returns CleanupFn

        A cleanup function to remove the listener.

    size: () => number

    Returns the number of listeners for this reactive variable.

    Type declaration

      • (): number

      • Returns number

        listener count.

    Settings

    Member Visibility

    On This Page

    Properties