@tim-code/my-util 0.2.6 → 0.3.0

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "",
   "type": "module",
-  "author": "",
+  "author": "Tim Sprowl",
   "license": "MIT",
   "sideEffects": false,
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",
+    "./array": "./src/array.js",
+    "./find": "./src/find.js",
     "./fs": "./src/fs.js",
-    "./run": "./src/run.js"
+    "./math": "./src/math.js",
+    "./object": "./src/object.js",
+    "./promise": "./src/promise.js",
+    "./run": "./src/run.js",
+    "./time": "./src/time.js"
   },
   "scripts": {
     "test": "node --no-warnings --experimental-vm-modules node_modules/.bin/jest"

package/src/promise.js

@@ -1,28 +1,44 @@
 import { chunk } from "./array.js"
 
+export class PollError extends Error {}
+
 /**
  * Calls a function immediately and then every X milliseconds until the function does not return undefined, null or false.
  * Note that other falsy values such as 0 or "" or NaN will resolve and be returned.
- * This will never resolve if callback always returns undefined, null, or false. I may add a "max attempt" or "timeout" option at some point.
- * @param {Function} callback
- * @param {number} milliseconds
- * @returns The result of the callback
+ * This will never resolve if callback always returns undefined, null, or false.
+ * @param {number} ms Milliseconds to wait between invocations
+ * @param {boolean|number=} wait If true, waits before initially calling the callback. If a number, waits that many milliseconds.
+ * @param {number=} attempts If a number, limits to that many invocations of callback before throwing a PollError.
+ * @param {Function} callback The argument is the number of times the callback has been called previously.
+ * @returns {any} The result of the callback
  */
-export function poll(callback, milliseconds) {
+export function poll({ ms, wait = false, attempts = undefined }, callback) {
   return new Promise((resolve, reject) => {
+    let attemptIndex = 0
     const resolver = async () => {
+      if (typeof attempts === "number" && attemptIndex >= attempts) {
+        reject(new PollError("max attempts reached"))
+        return
+      }
       try {
-        const result = await callback()
+        const result = await callback(attemptIndex)
+        attemptIndex++
         if (result !== undefined && result !== null && result !== false) {
           resolve(result)
         } else {
-          setTimeout(resolver, milliseconds)
+          setTimeout(resolver, ms)
         }
       } catch (error) {
         reject(error)
       }
     }
-    resolver()
+    if (typeof wait === "number") {
+      setTimeout(resolver, wait)
+    } else if (wait === true) {
+      setTimeout(resolver, ms)
+    } else {
+      resolver()
+    }
   })
 }
 

package/src/promise.test.js

@@ -2,14 +2,15 @@
 /* eslint-disable prefer-promise-reject-errors */
 import { jest } from "@jest/globals"
 
-const { poll, sleep, allSettled, alert, throwFirstReject } = await import("./promise.js")
+import { alert, allSettled, poll, PollError, sleep, throwFirstReject } from "./promise.js"
 
 describe("poll", () => {
   it("resolves immediately if callback returns a non-undefined/null/false value", async () => {
     const cb = jest.fn().mockReturnValue(42)
-    const promise = poll(cb, 1000)
+    const promise = poll({ ms: 1 }, cb)
     await expect(promise).resolves.toBe(42)
     expect(cb).toHaveBeenCalledTimes(1)
+    expect(cb).toHaveBeenCalledWith(0)
   })
 
   it("resolves after several attempts when callback returns undefined/null/false before a value", async () => {
@@ -19,23 +20,19 @@ describe("poll", () => {
       .mockReturnValueOnce(null)
       .mockReturnValueOnce(false)
       .mockReturnValueOnce(0)
-    const promise = poll(cb, 500)
-    // Advance timers for 3 unsuccessful attempts (undefined, null, false)
-    const before = Date.now()
-    // The fourth call returns 0, which should resolve
+    const promise = poll({ ms: 2 }, cb)
     await expect(promise).resolves.toBe(0)
-    const after = Date.now()
-    expect((after - before) / 1000).toBeCloseTo(1.5, 1)
     expect(cb).toHaveBeenCalledTimes(4)
+    expect(cb.mock.calls.map((args) => args[0])).toEqual([0, 1, 2, 3])
   })
 
   it('resolves if callback returns "" or NaN (should not treat as "keep polling")', async () => {
     const cb = jest.fn().mockReturnValueOnce("").mockReturnValueOnce(NaN)
-    const promise1 = poll(cb, 100)
+    const promise1 = poll({ ms: 1 }, cb)
     await expect(promise1).resolves.toBe("")
     expect(cb).toHaveBeenCalledTimes(1)
     cb.mockClear()
-    const promise2 = poll(cb, 100)
+    const promise2 = poll({ ms: 1 }, cb)
     await expect(promise2).resolves.toBe(NaN)
     expect(cb).toHaveBeenCalledTimes(1)
   })
@@ -45,26 +42,67 @@ describe("poll", () => {
     const cb = jest.fn().mockImplementation(() => {
       throw error
     })
-    await expect(poll(cb, 100)).rejects.toBe(error)
+    await expect(poll({ ms: 1 }, cb)).rejects.toBe(error)
     expect(cb).toHaveBeenCalledTimes(1)
   })
 
   it("rejects if callback returns a rejected promise", async () => {
     const error = new Error("async fail")
     const cb = jest.fn().mockReturnValue(Promise.reject(error))
-    const promise = poll(cb, 100)
+    const promise = poll({ ms: 1 }, cb)
     await expect(promise).rejects.toBe(error)
     expect(cb).toHaveBeenCalledTimes(1)
   })
+
+  it("waits before first call if wait=true", async () => {
+    const cb = jest.fn().mockReturnValue(1)
+    const promise = poll({ ms: 2, wait: true }, cb)
+    // Wait a little longer than ms to ensure callback is called
+    await sleep(3)
+    await expect(promise).resolves.toBe(1)
+    expect(cb).toHaveBeenCalledTimes(1)
+  })
+
+  it("waits specified ms before first call if wait is a number", async () => {
+    const cb = jest.fn().mockReturnValue(1)
+    const promise = poll({ ms: 2, wait: 5 }, cb)
+    await sleep(4)
+    expect(cb).not.toHaveBeenCalled()
+    await sleep(2)
+    await expect(promise).resolves.toBe(1)
+    expect(cb).toHaveBeenCalledTimes(1)
+  })
+
+  it("rejects with PollError if attempts is reached", async () => {
+    const cb = jest.fn().mockReturnValue(undefined)
+    const promise = poll({ ms: 1, attempts: 3 }, cb)
+    await expect(promise).rejects.toBeInstanceOf(PollError)
+    await expect(promise).rejects.toThrow("max attempts reached")
+    expect(cb).toHaveBeenCalledTimes(3)
+    expect(cb.mock.calls.map((args) => args[0])).toEqual([0, 1, 2])
+  })
+
+  it("resolves if callback returns a value before reaching max attempts", async () => {
+    const cb = jest
+      .fn()
+      .mockReturnValueOnce(undefined)
+      .mockReturnValueOnce(undefined)
+      .mockReturnValueOnce(5)
+    const promise = poll({ ms: 1, attempts: 5 }, cb)
+    await expect(promise).resolves.toBe(5)
+    expect(cb).toHaveBeenCalledTimes(3)
+    expect(cb.mock.calls.map((args) => args[0])).toEqual([0, 1, 2])
+  })
 })
 
 describe("sleep", () => {
   it("resolves after the specified milliseconds", async () => {
     const before = Date.now()
-    const promise = sleep(500)
+    const promise = sleep(5)
     await expect(promise).resolves.toBeUndefined()
     const after = Date.now()
-    expect((after - before) / 1000).toBeCloseTo(0.5, 1)
+    // Allow for some jitter
+    expect(after - before).toBeGreaterThanOrEqual(5)
   })
 })
 
@@ -172,3 +210,12 @@ describe("throwFirstReject", () => {
     expect(result.returned).toEqual([])
   })
 })
+
+describe("PollError", () => {
+  it("is an Error subclass", () => {
+    const err = new PollError("oops")
+    expect(err).toBeInstanceOf(Error)
+    expect(err).toBeInstanceOf(PollError)
+    expect(err.message).toBe("oops")
+  })
+})