https://github.com/lh0x00/unblock

this package provides `this.unblock` inside Meteor publications
https://github.com/lh0x00/unblock

ddp hack meteor meteorjs meteorx performance publications subscriptions unblock

Last synced: about 2 months ago
JSON representation

this package provides `this.unblock` inside Meteor publications

• Host: GitHub
• URL: https://github.com/lh0x00/unblock
• Owner: lh0x00
• License: mit
• Fork: true (meteorhacks/unblock)
• Created: 2018-12-02T09:14:41.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-31T07:43:47.000Z (11 months ago)
• Last Synced: 2024-09-25T20:01:15.872Z (about 2 months ago)
• Topics: ddp, hack, meteor, meteorjs, meteorx, performance, publications, subscriptions, unblock
• Language: JavaScript
• Homepage: https://atmospherejs.com/lamhieu/unblock
• Size: 13.7 KB
• Stars: 16
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unblock

[![github issues][github-issues-image]][github-issues-url]

[![build status][travis-image]][github-project-url]

Use this.unblock inside Meteor Publications. This is a project to provide `this.unblock` functionality to publications for versions of meteor below 2.3. `this.unblock` is [supported](https://github.com/meteor/meteor/pull/11392) for meteor versions 2.3 and above.

`this.unblock` inside publications is one of most(may be a little bit less) [requested](https://github.com/meteor/meteor/issues/853) feature and but it hasn't been implemented yet!

Fork from [meteorhacks/unblock](https://github.com/meteorhacks/unblock). I will maintain it and update it in the future. If you find an error, please open the issue in this project!

## Why unblock?

Meteor executes, DDP messages for a single client in a sequence. So, if one message takes a lot of time to process, that time will add up to all the messages. Luckily, there is an API called `this.unblock` which can be use inside methods as shown below.

```javascript

Meteor.methods({

  longMethod: function() {

    this.unblock();

    Meteor._sleepForMs(1000 * 60 * 60);

  },

});

```

So, other messages can start processing without waiting for the above method.

**Unfortunately**, this is not available for Publications (subscriptions) for no reason. But now you can possible it with this project.

## Installation

read more in [atmospherejs](https://atmospherejs.com/lamhieu/unblock)

```bash

$ meteor add lamhieu:unblock

```

Use it inside your publications, if that takes too much time or you don't need subscriptions from other publications to wait on this.

```javascript

Meteor.publish("publicationName", function() {

  this.unblock(); // yeah!

  Meteor._sleepForMs(1000 * 60 * 60);

});

```

[github-project-url]: https://github.com/lamhieu-vk/unblock

[travis-image]: https://travis-ci.com/lamhieu-vk/unblock.svg?branch=master

[github-issues-image]: https://img.shields.io/github/issues/lamhieu-vk/unblock.svg

[github-issues-url]: https://github.com/lamhieu-vk/unblock/issues