Skip to content

Commit

Permalink
docs(shareReplay): remove marble diagram (#7051)
Browse files Browse the repository at this point in the history
Closes #6989
  • Loading branch information
jakovljevic-mladen authored Sep 25, 2022
1 parent 54b36cb commit 35aae6e
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/internal/operators/shareReplay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ export function shareReplay<T>(bufferSize?: number, windowTime?: number, schedul
*
* This operator is a specialization of `replay` that connects to a source observable
* and multicasts through a `ReplaySubject` constructed with the specified arguments.
* A successfully completed source will stay cached in the `shareReplayed observable` forever,
* A successfully completed source will stay cached in the `shareReplay`ed observable forever,
* but an errored source can be retried.
*
* ## Why use shareReplay?
* ## Why use `shareReplay`?
*
* You generally want to use `shareReplay` when you have side-effects or taxing computations
* that you do not wish to be executed amongst multiple subscribers.
* It may also be valuable in situations where you know you will have late subscribers to
* a stream that need access to previously emitted values.
* This ability to replay values on subscription is what differentiates {@link share} and `shareReplay`.
*
* ![](shareReplay.png)
*
* ## Reference counting
*
* By default `shareReplay` will use `refCount` of false, meaning that it will _not_ unsubscribe the
* source when the reference counter drops to zero, i.e. the inner `ReplaySubject` will _not_ be unsubscribed
* (and potentially run for ever).
Expand Down Expand Up @@ -143,9 +143,10 @@ export function shareReplay<T>(bufferSize?: number, windowTime?: number, schedul
* @see {@link share}
* @see {@link publishReplay}
*
* @param {Number} [bufferSize=Infinity] Maximum element count of the replay buffer.
* @param {Number} [windowTime=Infinity] Maximum time length of the replay buffer in milliseconds.
* @param {Scheduler} [scheduler] Scheduler where connected observers within the selector function
* @param configOrBufferSize Maximum element count of the replay buffer or {@link ShareReplayConfig configuration}
* object.
* @param windowTime Maximum time length of the replay buffer in milliseconds.
* @param scheduler Scheduler where connected observers within the selector function
* will be invoked on.
* @return A function that returns an Observable sequence that contains the
* elements of a sequence produced by multicasting the source sequence within a
Expand Down

0 comments on commit 35aae6e

Please sign in to comment.