W3cubDocs

/RxJS

publishReplay

function deprecated operator

Deprecation Notes

Will be removed in v8. Use the connectable observable, the connect operator or the share operator instead. See the overloads below for equivalent replacement examples of this operator's behaviors. Details: https://rxjs.dev/deprecations/multicasting

publishReplay<T, R>(bufferSize?: number, windowTime?: number, selectorOrScheduler?: TimestampProvider | OperatorFunction<T, R>, timestampProvider?: TimestampProvider)

Parameters

bufferSize number

Optional. Default is undefined.
windowTime number

Optional. Default is undefined.
selectorOrScheduler TimestampProvider | OperatorFunction<T, R>

Optional. Default is undefined.
timestampProvider TimestampProvider

Optional. Default is undefined.

Overloads

publishReplay(bufferSize?: number, windowTime?: number, timestampProvider?: TimestampProvider): MonoTypeOperatorFunction<T>

Creates a ConnectableObservable that uses a ReplaySubject internally.

Parameters

bufferSize number

Optional. Default is undefined.

The buffer size for the underlying ReplaySubject.
windowTime number

Optional. Default is undefined.

The window time for the underlying ReplaySubject.
timestampProvider TimestampProvider

Optional. Default is undefined.

The timestamp provider for the underlying ReplaySubject.

Returns

MonoTypeOperatorFunction<T>

publishReplay(bufferSize: number, windowTime: number, selector: (shared: Observable<T>) => O, timestampProvider?: TimestampProvider): OperatorFunction<T, ObservedValueOf<O>>

Creates an observable, that when subscribed to, will create a ReplaySubject, and pass an observable from it (using asObservable) to the selector function, which then returns an observable that is subscribed to before "connecting" the source to the internal ReplaySubject.

Parameters

bufferSize number

The buffer size for the underlying ReplaySubject.
windowTime number

The window time for the underlying ReplaySubject.
selector (shared: Observable<T>) => O

A function used to setup the multicast.
timestampProvider TimestampProvider

Optional. Default is undefined.

The timestamp provider for the underlying ReplaySubject.

Returns

OperatorFunction<T, ObservedValueOf<O>>

Since this is deprecated, for additional details see the documentation for connect.

publishReplay(bufferSize: number, windowTime: number, selector: undefined, timestampProvider: TimestampProvider): OperatorFunction<T, ObservedValueOf<O>>

Creates a ConnectableObservable that uses a ReplaySubject internally.

Parameters

bufferSize number

The buffer size for the underlying ReplaySubject.
windowTime number

The window time for the underlying ReplaySubject.
selector undefined

Passing undefined here determines that this operator will return a ConnectableObservable.
timestampProvider TimestampProvider

The timestamp provider for the underlying ReplaySubject.

Returns

OperatorFunction<T, ObservedValueOf<O>>

© 2015–2022 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.
Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
https://rxjs.dev/api/operators/publishReplay