rx-subscription

The Reactive Extensions for JavaScript (RxJS) Subscription object.

Documentation

Subscription Members

• Subscription.create
• Subscription.empty
• Subscription.prototype.unsubscribe

---

Subscription.create(action)

#Ⓢ [Ⓣ][1]

Creates a new instance of the SingleAssignmentSubscription class.

Example

var Subscription = require('rx-subscription')
 
// Create the instance
var s = Subscription.create(function () {
  console.log('unsubscribed');
});
 
s.unsubscribe();
// => unsubscribed
 
s.unsubscribe();

---

Subscription.empty

#Ⓢ [Ⓣ][1]

Gets the subscription that does nothing when unsubscribed.

Returns

(Subscription): A subscription which does nothing when unsubscribed.

Example

var Subscription = require('rx-subscription')
 
var empty = Subscription.empty;
 
empty.unsubscribe();

---

Subscription.prototype.unsubscribe()

#Ⓢ [Ⓣ][1]

Unsubscribes from the underlying subscription.

Example

var Subscription = require('rx-subscription')
 
// Create the instance
var s = Subscription.create(function () {
  console.log('unsubscribed');
});
 
s.unsubscribe();
// => unsubscribed
 
s.unsubscribe();

---

Installation

Using npm:

npm rx-subscription

License

Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.