- useSubscription<TSubscriptionFnData, TError, TData, TSubscriptionKey>(subscriptionKey: TSubscriptionKey, subscriptionFn: ((context: QueryFunctionContext<TSubscriptionKey, any>) => Observable<TSubscriptionFnData>), options?: UseSubscriptionOptions<TSubscriptionFnData, TError, TData, TSubscriptionKey>): UseSubscriptionResult<TData, TError>
-
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>
React hook based on React Query for managing, caching and syncing observables in React.
Example