npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ovh-angular-swimming-poll

v3.0.0

Published

A poller to swim easily to success status!

Downloads

11

Readme

githubbanner

Maintenance Chat on gitter Build Status

NPM

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.

function (Poller) {
    var url = '/task/42';
    Poller.poll(
        url,
        null,   // params
        {
            namespace: 'a_namespace',
            method: 'get',
            scope: $scope.$id
        }
    ).then(function (result) {
        console.log('result contains http response if task status is successful');
    }, function (result) {
        console.log('result contains http response if task status is in error state');
    }, function (result) {
        console.log('result contains http response if task status is in pending state');
    });

With custom validation rules

When you want to poll another thing that an OVH task, you had to define your custom validation rules.

function (Poller) {
    var url = '/ip/192.168.1.1/status';
    Poller.poll(
        url,
        {
            headers: 'demo'
        },
        {
            namespace: 'a_namespace',
            method: 'get',
            scope: $scope.$id,
            successRule: { 
                status: 'yeah_it_works', 
                billingStatus : function (elem) {
                    return elem.billing.status === 'nietMeerGeld';
                }
            },
            errorRule: { 
                status: 'oh_damned',
                billingStatus : function (elem) {
                    return elem.billing.status === 'verdom';
                }
            }
        }
    ).then(function (result) {
        console.log('result contains http response if status is yeah_it_works');
    }, function (result) {
        console.log('result contains http response if status is oh_damned');
    }, function (result) {
        console.log('result contains http response if status is not oh_damned and not yeah_it_works');
    });

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
function (Poller) {
    var url = '/ip';
    Poller.poll(
        url,
        {
            headers: 'demo'
        },
        {
            namespace: 'a_namespace',
            method: 'get',
            scope: $scope.$id,
            successRule: { 
                status: 'yeah_it_works', 
                billingStatus : function (elem) {
                    return elem.billing.status === 'nietMeerGeld';
                }
            },
            errorRule: { 
                status: 'oh_damned',
                billingStatus : function (elem) {
                    return elem.billing.status === 'verdom';
                }
            }
        }
    ).then(function (result) {
        console.log('result contains http response if all statuses are yeah_it_works');
    }, function (result) {
        console.log('result contains http response if one or more status is oh_damned and other yeah_it_works');
    }, function (result) {
        console.log('result contains http response if one or more status is not a finalized status');
    });

With time interval

You can specify the interval as a fix value or a function

function (Poller) {
    var url = '/task/42';
    Poller.poll(
        url,
        null,   // params
        {
            namespace: 'a_namespace',
            method: 'get',
            scope: $scope.$id,
            interval: function(iteration) {
                return 10 * Math.exp(iteration);
            }
        }
    ).then(function (result) {
        console.log('result contains http response if task status is successful');
    }, function (result) {
        console.log('result contains http response if task status is in error state');
    }, function (result) {
        console.log('result contains http response if task status is in pending state');
    });

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