|
| 1 | +export default function useTimerHelper () { |
| 2 | + /** |
| 3 | + * Asynchronously waits while a condition remains true, checking at regular intervals. |
| 4 | + * |
| 5 | + * @param {boolean|Function} condition - A boolean value or a function that returns a boolean. |
| 6 | + * The waiting continues while this evaluates to true. |
| 7 | + * @param {Object} options - Configuration options for the waiting behavior. |
| 8 | + * @param {number} [options.cutoffTries=Infinity] - Maximum number of attempts before throwing an error. |
| 9 | + * Must be a non-negative finite number. |
| 10 | + * @param {number} [options.intervalMs=1000] - Time in milliseconds to wait between condition checks. |
| 11 | + * Must be a non-negative finite number. |
| 12 | + * @returns {Promise<void>} Resolves when the condition becomes false. |
| 13 | + * @throws {Error} If intervalMs or cutoffTries are invalid (negative or non-finite). |
| 14 | + * @throws {Error} If the maximum number of tries (cutoffTries) is reached before condition becomes false. |
| 15 | + */ |
| 16 | + async function waitWhile (condition, { cutoffTries = Infinity, intervalMs = 1000 } = {}) { |
| 17 | + const predicate = (typeof condition === 'function') |
| 18 | + ? condition |
| 19 | + : () => Boolean(condition) |
| 20 | + |
| 21 | + const delayMs = Number(intervalMs) |
| 22 | + if (!Number.isFinite(delayMs) || delayMs < 0) { |
| 23 | + throw new Error(`waitWhile: intervalMs must be a non-negative number, got ${intervalMs}`) |
| 24 | + } |
| 25 | + |
| 26 | + const maxTries = Number(cutoffTries) |
| 27 | + if (!Number.isFinite(maxTries) || maxTries < 0) { |
| 28 | + throw new Error(`waitWhile: cutoffTries must be a non-negative number, got ${cutoffTries}`) |
| 29 | + } |
| 30 | + |
| 31 | + let tries = 0 |
| 32 | + while (predicate()) { |
| 33 | + if (tries >= maxTries) { |
| 34 | + throw new Error(`waitWhile: cutoffTries (${maxTries}) reached`) |
| 35 | + } |
| 36 | + tries++ |
| 37 | + await new Promise(resolve => setTimeout(resolve, delayMs)) |
| 38 | + } |
| 39 | + } |
| 40 | + |
| 41 | + return { |
| 42 | + waitWhile |
| 43 | + } |
| 44 | +} |
0 commit comments