Options
All
  • Public
  • Public/Protected
  • All
Menu

rx-event-source - v1.2.0

Index

Functions

  • eventSource$<TData>(url: string, configuration?: EventSourceInit, options?: EventSourceOptions<TData>): Observable<TData>
  • Creates event source from url (and config) and returns an observable with parsed event source data. Opens the event source once subscribed. Closes the event source, once unsubscribed.

    example
    const options = {
    // ...
    };
    const sse$ = eventSource$(
    'https://example.com/sse',
    { withCredentials: false }, // or true
    options
    );
    sse$.subscribe((data) => {
    console.log(data);
    });

    Type parameters

    • TData = unknown

    Parameters

    • url: string
    • Optional configuration: EventSourceInit
    • Optional options: EventSourceOptions<TData>

    Returns Observable<TData>

  • fromEventSource<TData>(sse: EventSource, options?: EventSourceOptions<TData>): Observable<TData>
  • Takes EventSource and creates an observable from it.

    example
    const sse = new EventSource(url, configuration);
    const options = {
    // ...
    };
    return fromEventSource(sse, options).pipe(
    finalize(() => {
    // Make sure the EventSource is closed once not needed.
    sse.close();
    }),
    );

    Type parameters

    • TData = unknown

    Parameters

    Returns Observable<TData>

Generated using TypeDoc