• React hook based on React Query for managing, caching and syncing observables in React.

    Example

    function ExampleSubscription() {
    const { data, isError, error, isLoading } = useSubscription(
    'test-key',
    () => stream$,
    {
    // options
    }
    );

    if (isLoading) {
    return <>Loading...</>;
    }
    if (isError) {
    return (
    <div role="alert">
    {error?.message || 'Unknown error'}
    </div>
    );
    }
    return <>Data: {JSON.stringify(data)}</>;
    }

    Type Parameters

    • TSubscriptionFnData = unknown

    • TError = Error

    • TData = TSubscriptionFnData

    • TSubscriptionKey extends QueryKey = QueryKey

    Parameters

    • subscriptionKey: TSubscriptionKey
    • subscriptionFn: ((context: QueryFunctionContext<TSubscriptionKey, any>) => Observable<TSubscriptionFnData>)
        • (context: QueryFunctionContext<TSubscriptionKey, any>): Observable<TSubscriptionFnData>
        • Parameters

          • context: QueryFunctionContext<TSubscriptionKey, any>

          Returns Observable<TSubscriptionFnData>

    • options: UseSubscriptionOptions<TSubscriptionFnData, TError, TData, TSubscriptionKey> = {}

    Returns UseSubscriptionResult<TData, TError>

Generated using TypeDoc