View our GitHub

Please visit sails-docs on GitHub to view documentation on your mobile device.

Edit Page

.unsubscribe(request,records,[contexts])

Purpose

This method will unsubscribe a socket from one or more model instances.

Description Accepted Data Types Required ?
1 Request Request object Yes
2 Records [], object Yes
3 Contexts to unsubscribe from string, array No

Note: unsubscribe will only work when the request is made over a socket connection (e.g. using socket.get), not over an http connection (e.g. using jquery.get).

context

See .subscribe() for a discussion of pubsub contexts. Omit this argument to unsubscribe a socket from all contexts.

Example Usage

Controller Code

User.findOne({id: 123}).exec(function(err, userInstance) {
    User.unsubscribe(req.socket, userInstance);
});

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Reference

We wrote a book!

Get early access to the book
with promotion code: mcneildoc

Get the Book