1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
|
# `Rx.Subscription` class #
Records information about subscriptions to and unsubscriptions from observable sequences.
### Location
- rx.testing.js
## `Subscription Constructor` ##
- [`constructor`](#rxsubscriptionsubscribe-unsubscribe)
## `Subscription Instance Methods` ##
- [`equals`](#rxsubscriptionprototypeequalsother)
- [`toString`](#rxsubscriptionprototypetostring)
## `Subscription Instance Properties` ##
- [`subscribe`](#subscribe)
- [`unsubscribe`](#unsubscribe)
## _Subscription Constructor_ ##
### <a id="rxsubscriptionsubscribe-unsubscribe"></a>`Rx.Subscription(subscribe, unsubscribe)`
<a href="#rxsubscriptionsubscribe-unsubscribe">#</a> [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/testing/subscription.js#L8-L11 "View in source")
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
```js
var subscription = new Rx.Subscription(200, 1000);
console.log(subscription.subscribe);
// => 200
console.log(subscription.unsubscribe);
// => 1000
```
### Location
- rx.testing.js
* * *
## _Subscription Instance Methods_ ##
### <a id="rxsubscriptionprototypeequalsother"></a>`Rx.Subscription.prototype.equals(other)`
<a href="#rxsubscriptionprototypeequalsother">#</a> [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/testing/subscription.js#L18-L20 "View in source")
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
```js
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
* * *
### <a id="rxsubscriptionprototypetostring"></a>`Rx.Subscription.prototype.toString()`
<a href="#rxsubscriptionprototypetostring">#</a> [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/testing/subscription.js#L30-L32 "View in source")
Returns a string representation of the current Subscription value.
#### Returns
*(String)*: String representation of the current Subscription value.
#### Example
```js
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_ ##
### <a id="subscribe"></a>`subscribe`
<a href="#subscribe">#</a> [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/testing/subscription.js#L8 "View in source")
Gets the subscription virtual time.
#### Returns
*(Number)*: The subscription virtual time.
#### Example
```js
var s1 = new Subscription(201);
console.log(s1.subscribe);
// => 201
```
### Location
- rx.testing.js
* * *
### <a id="unsubscribe"></a>`unsubscribe`
<a href="#value">#</a> [Ⓢ](https://github.com/Reactive-Extensions/RxJS/blob/master/src/core/testing/subscription.js#L9 "View in source")
Gets the unsubscription virtual time.
#### Returns
*(Number)*: The unsubscription virtual time.
#### Example
```js
var s1 = new Subscription(201, 500);
console.log(s1.unsubscribe);
// => 500
```
### Location
- rx.testing.js
* * *
|