monitor-api - v1.8.0
    Preparing search index...

    Function useSignal

    • Subscribes a React component to an SSignal value.

      This hook uses React's useSyncExternalStore, making it suitable for concurrent rendering while keeping React components in sync with monitor signals.

      Pass a selector to subscribe to part of the value: the component re-renders only when the selected value changes, compared with Object.is or the given isEqual. Use shallowEqual when the selector builds a new object or array.

      Type Parameters

      • T

      Parameters

      • signal: SSignal<T>

      Returns T

      const errorRate = useSignal(monitor.network.snapshot, (snap) => snap.window5s.errorRate)
      
    • Subscribes a React component to an SSignal value.

      This hook uses React's useSyncExternalStore, making it suitable for concurrent rendering while keeping React components in sync with monitor signals.

      Pass a selector to subscribe to part of the value: the component re-renders only when the selected value changes, compared with Object.is or the given isEqual. Use shallowEqual when the selector builds a new object or array.

      Type Parameters

      • T
      • S

      Parameters

      • signal: SSignal<T>
      • selector: (value: T) => S
      • OptionalisEqual: EqualityFn<S>

      Returns S

      const errorRate = useSignal(monitor.network.snapshot, (snap) => snap.window5s.errorRate)