UNPKG

@equinor/fusion-observable

Version:
24 lines (23 loc) 1.2 kB
import { type Observable, type ObservableInput } from 'rxjs'; import { type ObservableStateReturnType } from './useObservableState'; /** * React hook that converts an `ObservableInput` (Promise, Iterable, etc.) to * an RxJS `Observable`. The observable is memoised based on the input reference. * * @template T - The value type. * @param input - Any `ObservableInput<T>`. * @returns An `Observable<T>` wrapping the input. */ export declare const useObservableInput: <T>(input: ObservableInput<T>) => Observable<T>; /** * React hook that subscribes to an `ObservableInput` and tracks its latest * value, error, and completion state. * * @template TType - The value type. * @template E - The error type. * @template TInitial - The initial value type. * @param input - Any `ObservableInput<TType>` (Promise, array, observable, etc.). * @param initial - An initial value to use before the first emission. * @returns An object with `value`, `error`, and `complete` properties. */ export declare function useObservableInputState<TType, E = unknown, TInitial extends TType | undefined = undefined>(input: ObservableInput<TType>, initial: TType): ObservableStateReturnType<TType | TInitial, E>;