Nebulous Plasma Muffin

    ovh-angular-swimming-poll

    3.0.0 • Public • Published

    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

    License

    See https://github.com/ovh-ux/ovh-angular-swimming-poll/blob/master/LICENSE

    Keywords

    none

    Install

    npm i ovh-angular-swimming-poll

    DownloadsWeekly Downloads

    2

    Version

    3.0.0

    License

    BSD-3-Clause

    Last publish

    Collaborators

    • marie-j
    • jisay
    • axelpeter
    • blary_jp
    • antleblanc
    • cbourgois
    • ovh-ux-cds
    • lizardk
    • ovh
    • gioindahouz
    • jleveugle
    • bnjjj
    • khuang