poll-until-promise's Introduction

Poll Until Promise

Wait until the executed promise resolved to a true value, Execute it every x milliseconds and stop after y milliseconds.

Install

npm install poll-until-promise

Usage

const { waitFor } = require('poll-until-promise');

waitFor(() => fetch('/get-data'), { interval: 100 })
    // Tries every 100ms (from the last failure)
    .then(value => console.log('Yey', value))
    .catch(err => console.error(err));

const { PollUntil } = require('poll-until-promise');

const later = Date.now() + 1 * 1000; // 1 seconds into the future

let pollUntilPromise = new PollUntil();
pollUntilPromise
    .stopAfter(2 * 1000)    // Stop trying after 2 seconds
    .tryEvery(100)          // Tries every 100ms (from the last failure)
    .execute(() => {
        return new Promise((resolve, reject) => {
            if (+Date.now() >= later) {
                return resolve(true); // Some truthy value
            }
            reject(false);
        })
    })
    .then(value => console.log('Yey', value))
    .catch(err => console.error(err));

Options

const options = {
    interval: 100,
    timeout: 1000,
    stopOnFailure: false, // Ignores promise rejections
    verbose: false,

    // External Modules - e.g angularJs compatible
    setTimeout: $timeout,
    Promise: $q
};
let pollUntilPromise = new PollUntil(options);

Methods

isResolved

pollUntilPromise.isResolved()

isWaiting

pollUntilPromise.isWaiting()

getPromise

pollUntilPromise.getPromise().then(() => console.log('OMG'))

Another Example - Static Function

const PollUntil = require('poll-until-promise');
const later = Date.now() + 1 * 1000; // 1 seconds into the future

let pollUntilPromise = new PollUntil();
pollUntilPromise
    .stopAfter(2 * 1000)
    .tryEvery(100)
    .execute(() => {
        if (+Date.now() >= later) {
            return true;
        }
        return false;
    })
    .then((value) => console.log('Yey', value))
    .catch((err) => console.error(err));