Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

multicast

deprecated

An operator that creates a ConnectableObservable, that when connected, with the connect method, will use the provided subject to multicast the values from the source to all consumers.

@deprecated

Will be removed in v8. To create a connectable observable, use connectable. If you're using refCount after multicast, use the share operator instead. multicast(subject), refCount() is equivalent to share({ connector: () => subject, resetOnError: false, resetOnComplete: false, resetOnRefCountZero: false }). Details: https://rxjs.dev/deprecations/multicasting

function multicast<T>(subject: Subject<T>): UnaryFunction<Observable<T>, ConnectableObservable<T>>;

function multicast<T, O extends ObservableInput<any>>(subject: Subject<T>, selector: (shared: Observable<T>) => O): OperatorFunction<T, ObservedValueOf<O>>;

function multicast<T>(subjectFactory: () => Subject<T>): UnaryFunction<Observable<T>, ConnectableObservable<T>>;

function multicast<T, O extends ObservableInput<any>>(subjectFactory: () => Subject<T>, selector: (shared: Observable<T>) => O): OperatorFunction<T, ObservedValueOf<O>>;

multicast<T>(subject: Subject<T>): UnaryFunction<Observable<T>, ConnectableObservable<T>>

An operator that creates a ConnectableObservable, that when connected, with the connect method, will use the provided subject to multicast the values from the source to all consumers.

§Type Parameters

T

§Parameters

subject: Subject<T>

The subject to multicast through.

§Return Type

UnaryFunction<Observable<T>, ConnectableObservable<T>>

A function that returns a ConnectableObservable

multicast<T, O extends ObservableInput<any>>(subject: Subject<T>, selector: (shared: Observable<T>) => O): OperatorFunction<T, ObservedValueOf<O>>

Because this is deprecated in favor of the connect operator, and was otherwise poorly documented, rather than duplicate the effort of documenting the same behavior, please see documentation for the connect operator.

§Type Parameters

T

O extends ObservableInput<any>

§Parameters

subject: Subject<T>

The subject used to multicast.

selector: (shared: Observable<T>) => O

A setup function to setup the multicast

§Return Type

OperatorFunction<T, ObservedValueOf<O>>

A function that returns an observable that mirrors the observable returned by the selector.

multicast<T>(subjectFactory: () => Subject<T>): UnaryFunction<Observable<T>, ConnectableObservable<T>>

An operator that creates a ConnectableObservable, that when connected, with the connect method, will use the provided subject to multicast the values from the source to all consumers.

§Type Parameters

T

§Parameters

subjectFactory: () => Subject<T>

A factory that will be called to create the subject. Passing a function here will cause the underlying subject to be "reset" on error, completion, or refCounted unsubscription of the source.

§Return Type

UnaryFunction<Observable<T>, ConnectableObservable<T>>

A function that returns a ConnectableObservable

multicast<T, O extends ObservableInput<any>>(subjectFactory: () => Subject<T>, selector: (shared: Observable<T>) => O): OperatorFunction<T, ObservedValueOf<O>>

Because this is deprecated in favor of the connect operator, and was otherwise poorly documented, rather than duplicate the effort of documenting the same behavior, please see documentation for the connect operator.

§Type Parameters

T

O extends ObservableInput<any>

§Parameters

subjectFactory: () => Subject<T>

A factory that creates the subject used to multicast.

selector: (shared: Observable<T>) => O

A function to setup the multicast and select the output.

§Return Type

OperatorFunction<T, ObservedValueOf<O>>

A function that returns an observable that mirrors the observable returned by the selector.