feat(helpers): deprecate fromEventSource and eventSource$ helpers

Author: Katarina Anton

README.md

@@ -53,7 +53,8 @@ TODO
 ```TypeScript
 import { QueryClientProvider, QueryClient } from 'react-query';
 import { ReactQueryDevtools } from 'react-query/devtools';
-import { useSubscription, eventSource$ } from 'react-query-subscription';
+import { useSubscription } from 'react-query-subscription';
+import { eventSource$ } from 'rx-event-source';
 
 const queryClient = new QueryClient();
 
@@ -69,6 +70,7 @@ function App() {
 function SseExample() {
  const { data, isLoading, isError, error } = useSubscription(
  'some-key',
+ // @see https://kaciakmaciak.github.io/rx-event-source/modules.html#eventSource_
  () => eventSource$('/api/v1/sse'),
  {
  // options
@@ -89,6 +91,8 @@ function SseExample() {
 }
 ```
 
+See [`rx-event-source` docs](https://kaciakmaciak.github.io/rx-event-source).
+
 ### GraphQL subscription using [`graphql-ws`](https://github.com/enisdenjo/graphql-ws)
 
 ```TypeScript

src/helpers/event-source.ts

@@ -17,6 +17,8 @@ export interface EventSourceOptions<TData = unknown> {
 /**
  * Takes EventSource and creates an observable from it.
  *
+ * @deprecated Use `fromEventSource` from `rx-event-source` package instead.
+ *
  * @example
  * ```ts
  * const sse = new EventSource(url, configuration);
@@ -60,6 +62,8 @@ export function fromEventSource<TData = unknown>(
  * Opens the event source once subscribed.
  * Closes the event source, once unsubscribed.
  *
+ * @deprecated Use `eventSource$` from `rx-event-source` package instead.
+ *
  * @example
  * ```ts
  * const sse$ = eventSource$('https://example.com/sse', {