v2.0.4

README.md

@@ -4,7 +4,7 @@ This timer is very simple and framework independent.
 
 ## Install
 
-```
+```sh
 npm install @shhhplus/timer.js --save
 ```
 
@@ -15,27 +15,23 @@ npm install @shhhplus/timer.js --save
 ```javascript
 import createTimer from '@shhhplus/timer.js';
 
-// init
 const timer = createTimer({
   interval: 1000,
   onElapsed: () => {
     console.log('onElapsed ...');
   },
 });
 
-// start
-timer?.start();
+timer.start();
 
-// stop
-timer?.stop();
+timer.stop();
 ```
 
 ### async
 
 ```javascript
 import createTimer from '@shhhplus/timer.js';
 
-// init
 const timer = createTimer({
   interval: 5000,
   onElapsed: () => {
@@ -46,9 +42,7 @@ const timer = createTimer({
   },
 });
 
-// start
-timer?.start();
+timer.start();
 
-// stop
-timer?.stop();
+timer.stop();
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "timer.js",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "This timer is very simple and framework independent.",
   "keywords": [
     "timer",

src/demo.ts

@@ -7,9 +7,9 @@ const timer = createTimer({
   },
 });
 console.log('timer start');
-timer?.start();
+timer.start();
 
 setTimeout(() => {
   console.log('timer stop');
-  timer?.stop();
-}, 20000);
+  timer.stop();
+}, 5000);

src/index.test.ts

@@ -4,23 +4,7 @@ import createTimer from './index';
 // duration: |
 // ==|==|==|
 
-test('create timer should return null when interval <= 0', () => {
-  expect(
-    createTimer({
-      interval: 0,
-      onElapsed: () => {},
-    }),
-  ).toBe(null);
-
-  expect(
-    createTimer({
-      interval: -100,
-      onElapsed: () => {},
-    }),
-  ).toBe(null);
-});
-
-test('create timer should success when interval > 0', () => {
+test('create timer should success', () => {
   const timer = createTimer({
     interval: 100,
     onElapsed: () => {},
@@ -30,7 +14,7 @@ test('create timer should success when interval > 0', () => {
   expect(timer).toHaveProperty('stop');
 });
 
-test('timer.start can be called multiple times', (done) => {
+test('timer.start should be called multiple times', (done) => {
   const mockFn = jest.fn(() => {});
 
   const interval = 200;
@@ -40,19 +24,19 @@ test('timer.start can be called multiple times', (done) => {
     interval,
     onElapsed: mockFn,
   });
-  timer?.start();
-  timer?.start();
+  timer.start();
+  timer.start();
 
   const duration2stop = interval * (count + 1) - 1;
 
   setTimeout(() => {
-    timer?.stop();
+    timer.stop();
     expect(mockFn.mock.calls.length).toBe(count);
     done();
   }, duration2stop);
 });
 
-test('timer.stop can be called multiple times', (done) => {
+test('timer.stop should be called multiple times', (done) => {
   const mockFn = jest.fn(() => {});
 
   const interval = 200;
@@ -62,19 +46,49 @@ test('timer.stop can be called multiple times', (done) => {
     interval,
     onElapsed: mockFn,
   });
-  timer?.start();
+  timer.start();
 
   const duration2stop = interval * (count + 1) - 1;
 
   setTimeout(() => {
-    timer?.stop();
-    timer?.stop();
+    timer.stop();
+    timer.stop();
     expect(mockFn.mock.calls.length).toBe(count);
     done();
   }, duration2stop);
 });
 
-test('sync onElapsed should work', (done) => {
+test('onElapsed should not be called when interval = 0', (done) => {
+  const mockFn = jest.fn(() => {});
+  const timer = createTimer({
+    interval: 0,
+    onElapsed: mockFn,
+  });
+  timer.start();
+
+  setTimeout(() => {
+    timer.stop();
+    expect(mockFn.mock.calls.length).toBe(0);
+    done();
+  }, 100);
+});
+
+test('onElapsed should not be called when interval < 0', (done) => {
+  const mockFn = jest.fn(() => {});
+  const timer = createTimer({
+    interval: -1,
+    onElapsed: mockFn,
+  });
+  timer.start();
+
+  setTimeout(() => {
+    timer.stop();
+    expect(mockFn.mock.calls.length).toBe(0);
+    done();
+  }, 100);
+});
+
+test('sync onElapsed should be called', (done) => {
   const mockFn = jest.fn(() => {});
 
   const interval = 200;
@@ -84,21 +98,21 @@ test('sync onElapsed should work', (done) => {
     interval,
     onElapsed: mockFn,
   });
-  timer?.start();
+  timer.start();
 
   const duration2stop = interval * (count + 1) - 1;
 
   setTimeout(() => {
-    timer?.stop();
+    timer.stop();
     expect(mockFn.mock.calls.length).toBe(count);
     done();
   }, duration2stop);
 });
 
-test('async onElapsed should work', (done) => {
+test('async onElapsed should be called', (done) => {
   const mockFn = jest.fn(() => {});
 
-  const interval = 400;
+  const interval = 200;
   const duration = 100;
   const count = 5;
 
@@ -113,10 +127,10 @@ test('async onElapsed should work', (done) => {
       });
     },
   });
-  timer?.start();
+  timer.start();
 
   setTimeout(() => {
-    timer?.stop();
+    timer.stop();
     expect(mockFn.mock.calls.length).toBe(count);
     done();
   }, duration2stop);
@@ -126,7 +140,7 @@ test('stop timer before onElapsed is finished should work', (done) => {
   const mockFn = jest.fn(() => {});
 
   const interval = 100;
-  const duration = 400;
+  const duration = 200;
   const count = 3;
 
   const timer = createTimer({
@@ -138,10 +152,10 @@ test('stop timer before onElapsed is finished should work', (done) => {
       });
     },
   });
-  timer?.start();
+  timer.start();
 
   setTimeout(() => {
-    timer?.stop();
+    timer.stop();
   }, (interval + duration) * (count - 1) - duration / 2);
 
   setTimeout(() => {

src/index.ts

@@ -16,7 +16,10 @@ const doTask = (task: Options['onElapsed']) => {
 
 export default ({ interval, onElapsed }: Options) => {
   if (interval <= 0) {
-    return null;
+    return {
+      start: () => {},
+      stop: () => {},
+    };
   }
 
   let timer: NodeJS.Timeout | null = null;