disposable.md

This is RxJS v 4. Find the latest version here

Rx.Disposable class

Provides a set of static methods for creating Disposables, which defines a method to release allocated resources.

Usage

The follow example shows the basic usage of an Rx.Disposable.

var disposable = Rx.Disposable.create(function () {
    console.log('disposed');
});

disposable.dispose();
// => disposed

Disposable Class Methods

• create
• isDisposable

Disposable Class Properties

• empty

Disposable Instance Methods

• dispose

Class Methods

Rx.Disposable.create(action)

# [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/disposables/disposable.js"View in source")

Creates a disposable object that invokes the specified action when disposed.

Arguments

1. action (Function): Function to run during the first call to dispose. The action is guaranteed to be run at most once.

Returns

(Disposable): The disposable object that runs the given action upon disposal.

Example

var disposable = Rx.Disposable.create(function () {
    console.log('disposed');
});

disposable.dispose();
// => disposed

Location

File:

• /src/core/disposables/disposable.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

• RxJS-Complete
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/disposables/disposable.js

---

Rx.Disposable.isDisposable(d)

# [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/disposables/disposable.js"View in source")

Creates a disposable object that invokes the specified action when disposed.

Arguments

1. d (Object): Object to validate whether it has a dispose method.

Returns

(Boolean): true if is a disposable object, else false.

Example

var disposable = Rx.Disposable.empty;
console.log(disposable.isDisposable(disposable));
// => true

Location

File:

• /src/core/disposables/disposable.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

• RxJS-Complete
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/disposables/disposable.js

---

Disposable Class Properties

Rx.Disposable.empty

# Ⓢ

Gets the disposable that does nothing when disposed.

Returns

(Disposable): The disposable that does nothing when disposed.

Example

var disposable = Rx.Disposable.empty;

disposable.dispose(); // Does nothing

Location

File:

• /src/core/disposables/disposable.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

• RxJS-Complete
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/disposables/disposable.js

---

Disposable Instance Methods

Rx.Disposable.prototype.dispose()

# Ⓢ

Performs the task of cleaning up resources.

Example

var disposable = Rx.Disposable.create(function () {
    console.log('disposed');
});

disposable.dispose();
// => disposed

Location

Location

File:

• /src/core/disposables/disposable.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

• RxJS-Complete
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/disposables/disposable.js

---