Subscription

Represents a disposable resource, such as the execution of an Observable. A Subscription has one important method, unsubscribe, that takes no argument and just disposes the resource held by the subscription.

Additionally, subscriptions may be grouped together through the add() method, which will attach a child Subscription to the current Subscription. When a Subscription is unsubscribed, all its children (and its grandchildren) will be unsubscribed as well.

class Subscription implements SubscriptionLike {

constructor(initialTeardown?: (() => void) | undefined);

private _addParent;

private _finalizers;

private _hasParent;

private _parentage;

private _removeParent;

private initialTeardown?;

closed: boolean;

add(teardown: TeardownLogic): void;

remove(teardown: Exclude<TeardownLogic, void>): void;

unsubscribe(): void;

static EMPTY: Subscription;

}

§Implements

SubscriptionLike

[src]

§Constructors

new Subscription(initialTeardown?: (() => void) | undefined)

[src]

@param initialTeardown

A function executed first as part of the finalization process that is kicked off when {@link #unsubscribe} is called.

§Properties

_addParent

[src]

Adds a parent to this subscription so it can be removed from the parent if it unsubscribes on it's own.

NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.

_finalizers

[src]

The list of registered finalizers to execute upon unsubscription. Adding and removing from this list occurs in the {@link #add} and {@link #remove} methods.

_hasParent

[src]

Checks to see if a this subscription already has a particular parent. This will signal that this subscription has already been added to the parent in question.

_parentage

[src]

_removeParent

[src]

Called on a child when it is removed via {@link #remove}.

initialTeardown

[src]

closed: boolean

[src]

A flag to indicate whether this Subscription has already been unsubscribed.

§Methods

add(teardown: TeardownLogic): void

[src]

Adds a finalizer to this subscription, so that finalization will be unsubscribed/called when this subscription is unsubscribed. If this subscription is already {@link #closed}, because it has already been unsubscribed, then whatever finalizer is passed to it will automatically be executed (unless the finalizer itself is also a closed subscription).

Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed subscription to a any subscription will result in no operation. (A noop).

Adding a subscription to itself, or adding null or undefined will not perform any operation at all. (A noop).

Subscription instances that are added to this instance will automatically remove themselves if they are unsubscribed. Functions and Unsubscribable objects that you wish to remove will need to be removed manually with {@link #remove}

@param teardown

The finalization logic to add to this subscription.

remove(teardown: Exclude<TeardownLogic, void>): void

[src]

Removes a finalizer from this subscription that was previously added with the {@link #add} method.

Note that Subscription instances, when unsubscribed, will automatically remove themselves from every other Subscription they have been added to. This means that using the remove method is not a common thing and should be used thoughtfully.

If you add the same finalizer instance of a function or an unsubscribable object to a Subscription instance more than once, you will need to call remove the same number of times to remove all instances.

All finalizer instances are removed to free up memory upon unsubscription.

@param teardown

The finalizer to remove from this subscription

unsubscribe(): void

[src]

Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

@return

§Static Properties

EMPTY: Subscription

[src]