Swimming-poll
A poller to swim easily to success status!
Features
- Understand standard Task states
- Customizable states (with object or function)
- Can share the result between differents scopes
- Can retry when error rejection is triggered (with retryMaxAttempts, retryCountAttempts and retryTimeoutDelay task options)
Install
NPM
$ npm install ovh-angular-swimming-poll --save
Bower
$ bower install ovh-angular-swimming-poll --save
Get the sources
$ git clone https://github.com/ovh-ux/ovh-angular-swimming-poll.git$ cd ovh-angular-swimming-poll$ npm install$ bower install
How to use?
With OVH standard task
The poller can manage return from OVH Task standard. This library understand OVH status and return promise when the task is finished.
{ var url = '/task/42'; Poller;
With custom validation rules
When you want to poll another thing that an OVH task, you had to define your custom validation rules.
{ var url = '/ip/192.168.1.1/status'; Poller;
With custom validations rules, on a listing
You can do a polling on listing request. In this case:
- promise will return success when all elements of the list are successful.
- promise will return error when one element or more in the list is in error state and all other are in success state
- else, promise will send a notify with the http response
{ var url = '/ip'; Poller;
With time interval
You can specify the interval as a fix value or a function
{ var url = '/task/42'; Poller;
Contributing
You've developed a new cool feature ? Fixed an annoying bug ? We'd be happy to hear from you !
Have a look in CONTRIBUTING.md
Run the tests
$ npm test
Related links
- Contribute: https://github.com/ovh-ux/ovh-angular-swimming-poll/blob/master/CONTRIBUTING.md
- Report bugs: https://github.com/ovh-ux/ovh-angular-swimming-poll/issues
- Get latest version: https://github.com/ovh-ux/ovh-angular-swimming-poll
License
See https://github.com/ovh-ux/ovh-angular-swimming-poll/blob/master/LICENSE