Documentation - v0.0.1
    Preparing search index...

    Interface ReadOnlySignal<T>

    interface ReadOnlySignal<T> {
        cleanup?: CleanupFn;
        get: () => T;
        registerDependency: (listener: (newValue: T) => void) => CleanupFn;
        unregisterAllDependencies: () => void;
    }

    Type Parameters

    • T

    Hierarchy

    • Omit<Signal<T>, "set" | "update">
      • ReadOnlySignal
    Index

    Properties

    cleanup?: CleanupFn

    Optional cleanup function to be called when the signal is no longer needed.

    get: () => T

    Retrieves the current value of the signal.

    registerDependency: (listener: (newValue: T) => void) => CleanupFn

    Registers a dependency listener that will be called whenever the signal value changes. Returns a function to unregister the listener.

    unregisterAllDependencies: () => void

    Unregisters all previously registered dependency listeners.