diff --git a/README.md b/README.md index 5723a01..8f6dcbb 100644 --- a/README.md +++ b/README.md @@ -493,10 +493,10 @@ Get events from a journal. ### eventsCoreAPI.getEventsObservableFromJournal(journalUrl, [eventsJournalOptions], [eventsJournalPollingOptions]) ⇒ Observable -getEventsObservableFromJournal returns an RxJS Observable +getEventsObservableFromJournal returns an RxJS Observable -One can go through the extensive documentation on RxJS in order to learn more -and leverage the various RxJS Operators to act on emitted events. +One can go through the extensive documentation on RxJS in order to learn more +and leverage the various RxJS Operators to act on emitted events. **Kind**: instance method of [EventsCoreAPI](#EventsCoreAPI) **Returns**: Observable - observable to which the user can subscribe to in order to listen to events diff --git a/src/index.js b/src/index.js index 98db145..c8f1d75 100644 --- a/src/index.js +++ b/src/index.js @@ -615,10 +615,10 @@ class EventsCoreAPI { * @property {number} [interval] Interval at which to poll the journal; If not provided, a default value will be used (optional) */ /** - * getEventsObservableFromJournal returns an RxJS Observable + * getEventsObservableFromJournal returns an RxJS Observable * - * One can go through the extensive documentation on RxJS in order to learn more - * and leverage the various RxJS Operators to act on emitted events. + * One can go through the extensive documentation on RxJS in order to learn more + * and leverage the various RxJS Operators to act on emitted events. * * @param {string} journalUrl URL of the journal or 'next' link to read from (required) * @param {EventsJournalOptions} [eventsJournalOptions] Query options to send with the Journal URL diff --git a/types.d.ts b/types.d.ts index 662f012..ff6179c 100644 --- a/types.d.ts +++ b/types.d.ts @@ -223,10 +223,10 @@ declare class EventsCoreAPI { */ getEventsFromJournal(journalUrl: string, eventsJournalOptions?: EventsJournalOptions, fetchResponseHeaders?: boolean): Promise; /** - * getEventsObservableFromJournal returns an RxJS Observable + * getEventsObservableFromJournal returns an RxJS Observable * - * One can go through the extensive documentation on RxJS in order to learn more - * and leverage the various RxJS Operators to act on emitted events. + * One can go through the extensive documentation on RxJS in order to learn more + * and leverage the various RxJS Operators to act on emitted events. * @param journalUrl - URL of the journal or 'next' link to read from (required) * @param [eventsJournalOptions] - Query options to send with the Journal URL * @param [eventsJournalPollingOptions] - Journal polling options