Subscription

Subscription

Representa un recurso desechable, como es la ejecución de un Observable. La Suscripción posee un método importante, unsubscribe, que no recibe ningún argumento y se encarga de desechar el recurso que representa la Suscripción

class Subscription implements SubscriptionLike {
static EMPTY: Subscription
constructor(unsubscribe?: () => void)
closed: [object Object]
unsubscribe(): void
add(teardown: TeardownLogic): Subscription
remove(subscription: Subscription): void
}

Subclases

Subscriber

Descripción

Adicionalmente, las suscripciones se pueden agrupar mediante el método add(), que adjunta una Suscripción hija a la Suscripción actual. Cuando se cancela una Suscripción, también se cancela la de todos sus hijos (y nietos.)

Propiedades Estáticas

Propiedad	Tipo	Descripción
EMPTY	Subscription

Constructor

constructor()
Firma constructor(unsubscribe?: () => void)

Parámetros

unsubscribe	Opcional. El valor por defecto es undefined. Una función que describe cómo llevar a cabo el desecho de recursos cuando el método unsubscribe es llamado.

Propiedades

Propiedad	Tipo	Descripción
closed	[object Object]	Indica si la Suscripción ha sido cancelada o no.

Métodos

unsubscribe()
Desecha los recursos representados por la Suscripción. Puede, por ejemplo, cancelar una ejecución Observable o cualquier otro tipo de trabajo que comenzase a partir de la creación de la Suscripción.
Firma unsubscribe(): void Parámetros No recibe ningún parámetro. Retorna void:

add()
Añade un teardown que será llamado durante el unsubscribe() de esta Suscripción. También se puede utilizar para añadir una Suscripción hija.
Firma add(teardown: TeardownLogic): Subscription Parámetros Retorna Subscription: Retorna la Suscripción utilizada o creada para ser añadida a la lista de Suscripciones internas. Esta Suscripción puede utilizarse junto a remove() para eliminar la lógica de teardown proporcionada de la lista de Suscripciones internas.
teardown	La lógica adicional a ejecutar durante el teardown (proceso de eliminación de recursos.)
Si el teardown que se quiere añadir es una Suscripción que ya ha sido cancelada, es la misma referencia que la referencia desde la que se está llamando add o es Subscription.EMPTY, no será añadido. Si esta Suscripción está en un estado cerrado, la lógica de teardown proporcionada será ejecutada inmediatamente. Cuando se cancela una Suscripción padre, cualquier Suscripción hija que se le hubiese añadido también se cancela.

remove()
Elimina una Suscripción de la lista interna de Suscripciones que serán canceladas durante el proceso de cancelación de esta Suscripción.
Firma remove(subscription: Subscription): void Parámetros Retorna void:
subscription	La suscripción a ser eliminada.

Recursos adicionales

Documentación oficial en inglés