Unsubscribe in Observable KnockOutJS

Question

Im currently using KnockOut JS and i conducted some research about when the observable is notified it will fire a function which is like this

function FunctionToSubscribe()
{

}

var TestObservable = ko.observableArray([]);

TestObservable.subscribe(FunctionToSubscribe);

i am subscribing FunctionToSubscribe in this event

im currently thinking is there a way to unsubscribe it? like we do in c#? when unsubscribing events anyone have an idea regarding this???

score 18 · Accepted Answer · answered Nov 27 '14 at 06:43

18

The subscribe function returns the "subscription" object which has a dispose method what you can use to unsubscribe:

var TestObservable = ko.observableArray([]);

var subscription = TestObservable.subscribe(FunctionToSubscribe);

//call dispose when you want to unsubscribe
subscription.dispose();

See also in the documentation: Explicitly subscribing to observables

answered Nov 27 '14 at 06:43

nemesv

138,284
16
416
359

2

Is there a way to check if subscription has been disposed? – burktelefon Mar 02 '16 at 14:53
1

@burktelefon The subscription object does not have a public API to check that it has has been dispose. – nemesv Mar 02 '16 at 15:20

score 3 · Answer 2 · answered Nov 27 '14 at 06:44

3

You can use dispose method.

function FunctionToSubscribe()
{

}

var TestObservable = ko.observableArray([]);

// subscribe
var subscriber = TestObservable.subscribe(FunctionToSubscribe);

// unsubscribe
subscriber.dispose();

answered Nov 27 '14 at 06:44

sadrzadehsina

1,331
13
26

CodingYoshi · Answer 3 · 2018-07-18T20:01:16.400

In my case I needed to temporarily pause the subscription and do some work so I ended up doing this:

ko.subscribable.fn.suspendableSubscribe = function (callback, callbackTarget, event) {
    var isSuspended = false;
    return ko.utils.extend(this.subscribe(function () {
        if (!isSuspended)
            return callback.apply(this, arguments);
    }, callbackTarget, event), {
        suspend: function () { isSuspended = true; },
        resume: function () { isSuspended = false; }
    });
};

Usage

var name = ko.observable('CodingYoshi');
var subscription = name.suspendableSubscribe(function(){ // code... });
subscription.suspend();
name('CodingYoshi2');
subscription.resume();

Unsubscribe in Observable KnockOutJS

3 Answers3