subscription.md

This is RxJS v 4. Find the latest version here

Rx.Subscription class

Records information about subscriptions to and unsubscriptions from observable sequences.

Location

• rx.testing.js

Subscription Constructor

• constructor

Subscription Instance Methods

• equals
• toString

Subscription Instance Properties

• subscribe
• unsubscribe

Subscription Constructor

Rx.Subscription(subscribe, unsubscribe)

# Ⓢ

Creates a new subscription object with the given virtual subscription and unsubscription time.

Arguments

1. subscribe (Number): Virtual time at which the subscription occurred.
2. [unsubscribe = Number.MAX_VALUE] (Number): Virtual time at which the unsubscription occurred.

Example

var subscription = new Rx.Subscription(200, 1000);

console.log(subscription.subscribe);
// => 200

console.log(subscription.unsubscribe);
// => 1000

Location

• rx.testing.js

---

Subscription Instance Methods

Rx.Subscription.prototype.equals(other)

# Ⓢ

Checks whether the given subscription is equal to the current instance.

Arguments

1. other (Subscription): Subscription object to check for equality.

Returns

(Boolean): Returns true if the Subscription equals the other, else false.

Example

var s1 = new Subscription(201, 500);
var s2 = new Subscription(201);
var s3 = new Subscription(201, 500);

console.log(s1.equals(s2));
// => false

console.log(s1.equals(s3));
// => true

Location

• rx.testing.js

---

Rx.Subscription.prototype.toString()

# Ⓢ

Returns a string representation of the current Subscription value.

Returns

(String): String representation of the current Subscription value.

Example

var s1 = new Subscription(201);

console.log(s1.toString());
// => (201, Infinite)

var s2 = new Subscription(201, 1000);
console.log(s2.toString());
// => (201, 1000)

Location

• rx.testing.js

---

Subscription Instance Properties

subscribe

# Ⓢ

Gets the subscription virtual time.

Returns

(Number): The subscription virtual time.

Example

var s1 = new Subscription(201);

console.log(s1.subscribe);
// => 201

Location

• rx.testing.js

---

unsubscribe

# Ⓢ

Gets the unsubscription virtual time.

Returns

(Number): The unsubscription virtual time.

Example

var s1 = new Subscription(201, 500);

console.log(s1.unsubscribe);
// => 500

Location

• rx.testing.js

---