WebSocketSubject

class WebSocketSubject<T> extends AnonymousSubject {
  constructor(
    urlConfigOrSource: string | WebSocketSubjectConfig<T> | Observable<T>,
    destination?: Observer<T>
  );
  _output: Subject<T>;
  lift<R>(operator: Operator<T, R>): WebSocketSubject<R>;
  multiplex(
    subMsg: () => any,
    unsubMsg: () => any,
    messageFilter: (value: T) => boolean
  );
  _subscribe(subscriber: Subscriber<T>): Subscription;
  unsubscribe();
}

Constructor

constructor()

Firma

constructor(urlConfigOrSource: string | WebSocketSubjectConfig | Observable, destination?: Observer)

Parámetros

urlConfigOrSource

Tipo: string | WebSocketSubjectConfig | Observable.

destination

Opcional. El valor por defecto es undefined. Tipo: Observer.

Propiedades

PropiedadTipoDescripción

_output

Subject

Métodos

lift()

Firma

lift(operator: Operator): WebSocketSubject

Parámetros

Retorna

WebSocketSubject

operator

Tipo: Operator.

multiplex()

Crea un Observable que, al ser suscrito, envía el mensaje definido por la función subMsg al servidor a través del socket para dar comienzo a una suscripción a datos a través de dicho socket. Una vez recibidos los datos, el argumento messageFilter se utilizará para seleccionar los datos apropiados para el Observable resultante. Cuando se ejecute la lógica de teardown, bien debido a la cancelación de la suscripción, a la completación o a un error, un mensaje definido por el argumento unsubMsg será enviado al servidor a través del WebSocketSubject.

Firma

multiplex(subMsg: () => any, unsubMsg: () => any, messageFilter: (value: T) => boolean)

Parámetros

subMsgUna función para generar el mensaje de suscripción que será enviado al servidor. Esto seguirá siendo procesado por el serializador en la configuración del WebSocketSubject (por defecto se utiliza la serialización JSON.)

unsubMsg

Una función para generar el menasje de cancelación de suscripción que será enviado al servidor cuando se ejecute la lógica de teardown. Esto seguirá siendo procesado por el serializador en la configuración del WebSocketSubject.

messageFilter

Un predicado para seleccionar los mensajes del servidor apropiados para el flujo resultante.

_subscribe()

Firma

_subscribe(subscriber: Subscriber): Subscription

Parámetros

Retorna

Subscription

subscriber

Tipo: Subscriber.

unsubscribe()

Firma

unsubscribe()

Parámetros

No recibe ningún parámetro.

Recursos adicionales

Documentación oficial en inglés

Last updated