grunt-wait-server
make grunt wait for server start
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-server --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "waitServer" task
Overview
In your project's Gruntfile, add a section named waitServer
or wait-server
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.req
Type: string
or an options object
Default value: undefined
See request#options for available options.
options.net
Type: options object
Default value: undefined
See net.connect#options for available options.
options.req
or options.net
.
You must supply either options.fail
Type: function
Default value: function () {}
options.timeout
Type: number
Default value: 10 * 1000
0
disables the timeout, will wait forever.
options.isforce
Type: boolean
Default value: false
options.interval
Type: number
Default value: 800
options.print
Type: boolean
Default value: true
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 waitServer
task will wait for the server start with the least options.
grunt;
Custom Options
grunt;
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)