Notification

Notificación

Representa un evento o valor push que puede emitir un Observable. Esta clase es especialmente útil para los operadores que gestionan notificaciones, como materialize, dematerialize, observeOn y demás. Además de crear una capa sobre el valor emitido, también lo anota con metadatos de, por ejemplo, qué tipo de mensaje push es (next, error o complete)

class Notification<T> {
  static createNext<T>(value: T): Notification<T>;
  static createError<T>(err?: any): Notification<T>;
  static createComplete(): Notification<any>;
  constructor(kind: "N" | "E" | "C", value?: T, error?: any);
  hasValue: boolean;
  kind: "N" | "E" | "C";
  value?: T;
  error?: any;
  observe(observer: PartialObserver<T>): any;
  do(
    next: (value: T) => void,
    error?: (err: any) => void,
    complete?: () => void
  ): any;
  accept(
    nextOrObserver:
      | NextObserver<T>
      | ErrorObserver<T>
      | CompletionObserver<T>
      | ((value: T) => void),
    error?: (err: any) => void,
    complete?: () => void
  );
  toObservable(): Observable<T>;
}

Métodos Estáticos

createNext()
Un atajo para crear una instancia de una Notificación de tipo next a partir de un valor dado.
Firma static createNext(value: T): Notification Parámetros value El valor next. Retorna Notification: La Notificación "next" que representa al argumento.
value	El valor next.

createError()
Un atajo para crear una instancia de una Notificación de tipo error a partir de un valor dado.
Firma static createError(err?: any): Notification Parámetros err Opcional. El valor por defecto es undefined. El error de error. Retorna Notification: La Notificación "error" que representa al argumento.
err	Opcional. El valor por defecto es undefined. El error de error.

createComplete()
Un atajo para crear una instancia de una Notificación de tipo complete.
Firma static createComplete(): Notification Parámetros No recibe ningún parámetro. Retorna Notification: La Notificación "complete", que carece de valor.

Constructor

constructor()
Firma constructor(kind: "N" | "E" | "C", value?: T, error?: any) Parámetros kind Tipo: "N" | "E" | "C". value Opcional. El valor por defecto es undefined. Tipo: T. error Opcional. El valor por defecto es undefined. Tipo: any.
kind	Tipo: "N" | "E" | "C".
value	Opcional. El valor por defecto es undefined. Tipo: T.
error	Opcional. El valor por defecto es undefined. Tipo: any.

Propiedades

Propiedad	Tipo	Descripción
hasValue	boolean
kind	'N' | 'E' | 'C'	Declarado en el constructor.
value	T	Declarado en el constructor.
error	any	Declarado en el constructor.

Métodos

observe()
Envía al observador proporcionado el valor englobado por esta Notificación.
Firma observe(observer: PartialObserver): any Parámetros observer Tipo: PartialObserver. Retorna any:
observer	Tipo: PartialObserver.

do()
Dada una callback de un Observador, envía el valor representado por la Notificación actual a la callback correspondiente.
Firma do(next: (value: T) => void, error?: (err: any) => void, complete?: () => void): any Parámetros next Una callback next de un Observador. error Una callback error de un Observador. Opcional. El valor por defecto es undefined. complete Una callback complete de un Observador. Opcional. El valor por defecto es undefined. Retorna any:
next	Una callback next de un Observador.
error	Una callback error de un Observador. Opcional. El valor por defecto es undefined.
complete	Una callback complete de un Observador. Opcional. El valor por defecto es undefined.

accept()
Recibe un Observador o sus funciones callback individuales y llama al método observe u otro método correspondiente.
Firma accept(nextOrObserver: NextObserver | ErrorObserver | CompletionObserver | ((value: T) => void), error?: (err: any) => void, complete?: () => void) Parámetros nextOrObserver Un Observador o una callback next error Una callback error de un Observador. Opcional. El valor por defecto es undefined. complete Una callback complete de un Observador. Opcional. El valor por defecto es undefined.
nextOrObserver	Un Observador o una callback next
error	Una callback error de un Observador. Opcional. El valor por defecto es undefined.
complete	Una callback complete de un Observador. Opcional. El valor por defecto es undefined.

toObservable()
Retorna un Observable simple que emite la notificación representada por esta instancia de Notificación.
Firma toObservable(): Observable Parámetros No recibe ningún parámetro. Retorna Observable:

Recursos adicionales

Documentación oficial en inglés