execute-until

A function that returns a promise that will only resolve when the predicate function resolves to true for async predicate or returns true for sync version. This is useful for cases when you need to perform some long running operation before proceeding.

The predicate function will be repeatedly called until it resolves to true which causes the asynchronous execution to proceed. By default, the predicate function is called every 500ms.

Please note that this function will reject when the predicate function throws an error/rejects at most 3 times.

Table of contents

• Installation
• Example usage

Installation

• npm

  npm i -S @lazycuh/execute-until
  

• pnpm

  pnpm i -S @lazycuh/execute-until
  

• yarn

  yarn add @lazycuh/execute-until
  

Example usage

import { executeUntil } from '@lazycuh/execute-until';

...

await executeUntil(async () => {
  const batchOfDatabaseRows = await fetchNextBatchOfDatabaseRows();

  if (batchOfDatabaseRows.length === 0) {
    /**
     * This will cause `executeUntil()` to terminate.
     */
    return true;
  }

  doSomethingWithBatch(batchOfDatabaseRows);

  /**
   * This will cause `executeUntil()` to run the predicate again.
   */
  return false;
});

doSomethingElseAfterProcessingAllDatabaseRows();

...