grunt-wait-async v0.1.1

grunt-wait-async

makes grunt wait for an async task

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-wait-async --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wait-async');

The "wait_async" task

Overview

In your project's Gruntfile, add a section named wait_async to the data object passed into grunt.initConfig().

grunt.initConfig({
  wait_async: {
    options: {
      wait: function (done) {
        done();
      },
      fail: function () {},
      timeout: 10 * 1000,
      isforce: false
    },
    server: {
      options: {
        wait: function (done) {
          done();
        },
        fail: function () {},
        timeout: 10 * 1000,
        isforce: false
      },
    },
  },
});

Options

options.wait

Type: function
Default value: function () {}

this options is required.

options.fail

Type: function
Default value: function () {}

options.timeout

Type: number
Default value: 10 * 1000

options.isforce

Type: boolean
Default value: false

When options.isforce is true, the task will continue after options.timeout, even if the done signal in options.wait never came.

Usage Examples

Default Options

In this example, the wait_async task will wait for the server start with the least options.

grunt.initConfig({
  wait_async: {
    server: {
      options: {
        wait: function (done) {
          setTimeout(function () {
            request('http://localhost:8080', function () {
              done();
            });
          }, 1000);
        }
      }
    }
  },
});

Custom Options

grunt.initConfig({
  wait_async: {
    server: {
      options: {
        wait: function (done) {
          setTimeout(function () {
            request('http://localhost:8080', function () {
              done();
            });
          }, 1000);
        },
        fail: function () {
          console.error('the server had not start'); 
        },
        timeout: 20 * 1000.
        isforce: true
      }
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)