Merge branch 'develop'

molvqingtai · Nov 30, 2024 · 665ad28 · 665ad28
2 parents 30fdc34 + 19bcf46
commit 665ad28
Show file tree

Hide file tree

Showing 14 changed files with 2,238 additions and 2,739 deletions.
diff --git a/.eslintrc b/.eslintrc
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,3 +1,5 @@
+# https://github.com/dependabot/dependabot-core/issues/1736
+
 version: 2
 updates:
   # Enable version updates for npm

diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -11,7 +11,7 @@ jobs:
   linter:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*
@@ -20,12 +20,12 @@ jobs:
           version: latest
       - run: pnpm install --ignore-scripts
       - run: pnpm run lint
-      - run: pnpm run tsc
+      - run: pnpm run check
   tests:
     needs: linter
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*
@@ -38,10 +38,7 @@ jobs:
     needs: tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-        # https://github.com/semantic-release/semantic-release/issues/2636
-        with:
-          persist-credentials: false
+      - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ jobs:
   linter:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*
@@ -20,12 +20,12 @@ jobs:
           version: latest
       - run: pnpm install --ignore-scripts
       - run: pnpm run lint
-      - run: pnpm run tsc
+      - run: pnpm run check
   tests:
     needs: linter
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-pnpm commitlint --edit ""
+pnpm commitlint --edit "$1"
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-pnpm run lint & pnpm run tsc
+pnpm lint-staged && pnpm check
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+  "eslint.options": {
+    "flags": ["unstable_ts_config"]
+  },
+  "eslint.useFlatConfig": true
+}
diff --git a/README.md b/README.md
@@ -1,19 +1,15 @@
 # Timer
 
-[![version](https://img.shields.io/github/v/release/molvqingtai/timer)](https://www.npmjs.com/package/timer) [![workflow](https://github.com/molvqingtai/timer/actions/workflows/ci.yml/badge.svg)](https://github.com/molvqingtai/timer/actions) [![download](https://img.shields.io/npm/dt/@resreq/timer)](https://www.npmjs.com/package/@resreq/timer) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-⏰ Short and sweet timer based on requestAnimationFrame API
-
+[![version](https://img.shields.io/github/v/release/molvqingtai/timer)](https://www.npmjs.com/package/@resreq/timer) [![workflow](https://github.com/molvqingtai/timer/actions/workflows/ci.yml/badge.svg)](https://github.com/molvqingtai/timer/actions) [![download](https://img.shields.io/npm/dt/@resreq/timer)](https://www.npmjs.com/package/@resreq/timer) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
+⏰ Short and sweet timer
 
 ## Install
 
 ```shell
 npm install @resreq/timer
 ```
 
-
-
 ## Usage
 
 ```typescript
@@ -22,7 +18,7 @@ import Timer from '@resreq/timer'
 const log = (time: number) => console.log('time:', time)
 
 const timer = new Timer(log, {
-  delay: 1000,
+  interval: 1000,
   immediate: true
 })
 
@@ -50,7 +46,17 @@ setTimeout(() => timer.stop(), 3000)
 // => stop: 1712160515855
 ```
 
+**Adapter**
+SetTimeout is used by default, and custom adapters are supported, such as requestAnimationFrame, cancelIdleCallback, etc...
 
+```typescript
+const timer = new Timer(log, {
+  adapter: {
+    setTimer: globalThis.requestAnimationFrame.bind(globalThis),
+    cancelTimer: globalThis.cancelAnimationFrame.bind(globalThis)
+  }
+})
+```
 
 ## LICENSE
 

diff --git a/__tests__/index.spec.ts b/__tests__/index.spec.ts
@@ -11,11 +11,11 @@ describe('Test timer', () => {
 
     test('Status should work properly', async () => {
       timer.start()
-      expect(timer.status).toBe('started')
+      expect(timer.status).toBe('running')
       timer.pause()
       expect(timer.status).toBe('paused')
       timer.start()
-      expect(timer.status).toBe('started')
+      expect(timer.status).toBe('running')
       timer.pause()
       expect(timer.status).toBe('paused')
       timer.stop()
@@ -27,7 +27,7 @@ describe('Test timer', () => {
     beforeEach(() => {
       timer = new Timer(() => 'foobar', {
         limit: 3,
-        delay: 50
+        interval: 50
       })
     })
     test('should emit start event', async () => {
@@ -100,7 +100,7 @@ describe('Test timer', () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
         limit: 3,
-        delay: 100
+        interval: 100
       })
       timer.start()
       await sleep(250)
@@ -112,7 +112,7 @@ describe('Test timer', () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
         limit: 3,
-        delay: 100
+        interval: 100
       })
       timer.start()
       await sleep(350)
@@ -123,7 +123,7 @@ describe('Test timer', () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
         limit: 3,
-        delay: 100
+        interval: 100
       })
       timer.start()
       await sleep(250)
@@ -135,11 +135,11 @@ describe('Test timer', () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
         limit: 5,
-        delay: 100
+        interval: 100
       })
       timer.start()
       await sleep(150)
-      // delay 100 < sleep 150 = +1 times
+      // interval 100 < sleep 150 = +1 times
       expect(callback).toHaveBeenCalledTimes(1)
       // last = 50
       timer.pause()
@@ -150,24 +150,24 @@ describe('Test timer', () => {
       timer.start()
       await sleep(75)
       timer.stop()
-      // delay < (last 50 + sleep 75)= +1 times
+      // interval < (last 50 + sleep 75)= +1 times
       expect(callback).toHaveBeenCalledTimes(2)
     })
 
     test('should call callback immediately', async () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
-        delay: 100,
+        interval: 100,
         immediate: true
       })
       timer.start()
-      await sleep(0)
+      await sleep(50)
       expect(callback).toHaveBeenCalledTimes(1)
     })
     test('should call callback reset', async () => {
       const callback = vi.fn()
       const timer = new Timer(callback, {
-        delay: 100,
+        interval: 100,
         limit: 1,
         immediate: false
       })
@@ -204,7 +204,7 @@ describe('Test timer', () => {
       }
       const timer = new Timer(promise, {
         limit: 3,
-        delay: 100,
+        interval: 100,
         includeAsyncTime: true
       })
       timer.start()
@@ -221,7 +221,7 @@ describe('Test timer', () => {
       }
       const timer = new Timer(promise, {
         limit: 3,
-        delay: 100,
+        interval: 100,
         includeAsyncTime: true
       })
       timer.start()
@@ -237,7 +237,7 @@ describe('Test timer', () => {
       }
       const timer = new Timer(promise, {
         limit: 3,
-        delay: 100,
+        interval: 100,
         includeAsyncTime: true
       })
       timer.start()
@@ -254,24 +254,24 @@ describe('Test timer', () => {
       }
       const timer = new Timer(promise, {
         limit: 5,
-        // delay = delay 100 + promise 100 = 200
-        delay: 100
+        // interval = interval 100 + promise 100 = 200
+        interval: 100
       })
       timer.start()
       await sleep(150)
-      // delay 200 > sleep 150 = +0 times
+      // interval 200 > sleep 150 = +0 times
       expect(callback).toHaveBeenCalledTimes(0)
       // Time is paused, but promise continues
       timer.pause()
       await sleep(100)
-      // delay 200 < (sleep 150 + sleep 100) = +1 times
+      // interval 200 < (sleep 150 + sleep 100) = +1 times
       // last = 50
       expect(callback).toHaveBeenCalledTimes(1)
       // inherit last 50
       timer.start()
       await sleep(180)
       timer.stop()
-      // delay 200 < (last 50 + sleep 180) = +1 times
+      // interval 200 < (last 50 + sleep 180) = +1 times
       expect(callback).toHaveBeenCalledTimes(2)
     })
 
@@ -281,12 +281,12 @@ describe('Test timer', () => {
         Promise.resolve(callback())
       }
       const timer = new Timer(promise, {
-        delay: 100,
+        interval: 100,
         immediate: true,
         includeAsyncTime: true
       })
       timer.start()
-      await sleep(0)
+      await sleep(50)
       expect(callback).toHaveBeenCalledTimes(1)
     })
 
@@ -296,12 +296,12 @@ describe('Test timer', () => {
         Promise.resolve(callback())
       }
       const timer = new Timer(promise, {
-        delay: 100,
+        interval: 100,
         immediate: false,
         includeAsyncTime: true
       })
       timer.start()
-      await sleep(0)
+      await sleep(50)
       expect(callback).toHaveBeenCalledTimes(0)
     })
 
@@ -311,7 +311,7 @@ describe('Test timer', () => {
         Promise.resolve(callback())
       }
       const timer = new Timer(promise, {
-        delay: 100,
+        interval: 100,
         limit: 1,
         immediate: false,
         includeAsyncTime: true
@@ -327,13 +327,17 @@ describe('Test timer', () => {
   describe('Test use timer in Callback', () => {
     test('should emit stop event', async () => {
       const callback = vi.fn()
-      const timer = new Timer((_, timer: Timer) => {
-        timer.stop()
-      })
-      timer.start()
+      const timer = new Timer(
+        (_, timer: Timer) => {
+          timer.stop()
+        },
+        { limit: 1 }
+      )
       timer.on('stop', callback)
-      await sleep(0)
-      expect(callback).toHaveBeenCalled()
+
+      timer.start()
+      await sleep(100)
+      expect(callback).toHaveBeenCalledTimes(1)
     })
   })
 })