@oscarpalmer/timer 0.4.0 → 0.7.0

package/.eslintrc.json

@@ -40,5 +40,5 @@
 				]
 			}
 		]
-	},
+	}
 }

package/README.md

@@ -1,7 +1,45 @@
 # Timer
 
-A better timer?
+[![npm version](https://badge.fury.io/js/@oscarpalmer%2Ftimer.svg)](https://badge.fury.io/js/@oscarpalmer%2Ftimer)
+
+A better solution for timeout- and interval-based timers.
+
+## Installation
+
+Timer is available on _npm_ as [`@oscarpalmer/timer`](https://www.npmjs.com/package/@oscarpalmer/timer).
+
+## Getting started
+
+This is fairily lightweight package, so hopefully you'll be up and running in seconds :blush:
+
+### Examples
+
+The timers can be called with nice helper methods, which also auto-start the timers:
+
+```typescript
+import {repeat, wait} from '@oscarpalmer/timer';
+
+let waited = wait(callback, time);
+let repeated = repeat(callback, time, count);
+```
+
+Or they can be created using class syntax, but without being auto-started:
+
+```typescript
+import {Repeated, Waited} from '@oscarpalmer/timer';
+
+waited = new Waited(callback, time);
+repeated = new Repeated(callback, time, count);
+```
+
+Both the nice helper methods and the class syntax create similar objects – `Waited` and `Repeated` – which share methods:
+
+|Method|Description|
+|-----:|:----------|
+|`start()`|Starts the timer: necessary when creating a timer using the class syntax _(e.g. `new Waited...`)_, but helpful when the timer needs to be started at other times, as well|
+|`stop()`|Stops the timer|
+|`restart()`|Restarts the timer|
 
 ## License
 
-[MI licensed](LICENSE), natch :blush:
+[MIT licensed](LICENSE), natch :wink:

package/dist/timer.js

@@ -1,4 +1,3 @@
-"use strict";
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {
@@ -7,7 +6,7 @@ var __publicField = (obj, key, value) => {
 };
 
 // src/index.ts
-var milliseconds = 1e3 / 60;
+var milliseconds = Math.round(1e3 / 60);
 var Timed = class {
   constructor(type, callback, time, count) {
     __publicField(this, "callback");
@@ -93,16 +92,15 @@ var Waited = class extends Timed {
     super("waited", callback, time, 1);
   }
 };
-var Timer = {
-  repeat: (callback, time, count) => {
-    return new Repeated(callback, time, count).start();
-  },
-  wait: (callback, time) => {
-    return new Waited(callback, time).start();
-  }
-};
+function repeat(callback, time, count) {
+  return new Repeated(callback, time, count).start();
+}
+function wait(callback, time) {
+  return new Waited(callback, time).start();
+}
 export {
   Repeated,
-  Timer,
-  Waited
+  Waited,
+  repeat,
+  wait
 };

package/package.json

@@ -3,17 +3,17 @@
 		"name": "Oscar Palmér",
 		"url": "https://oscarpalmer.se"
 	},
-	"description": "A better timer?",
+	"description": "A better solution for timeout- and interval-based timers.",
 	"devDependencies": {
 		"@tsconfig/recommended": "^1.0.0",
-		"@types/node": "^18.0.0",
-		"@typescript-eslint/eslint-plugin": "^5.30.0",
-		"@typescript-eslint/parser": "^5.30.0",
-		"esbuild": "^0.14.0",
-		"eslint": "^8.19.0",
-		"eslint-config-xo": "^0.41.0",
-		"eslint-config-xo-typescript": "^0.51.0",
-		"typescript": "^4.7.0"
+		"@types/node": "^18.7.0",
+		"@typescript-eslint/eslint-plugin": "^5.35.0",
+		"@typescript-eslint/parser": "^5.35.0",
+		"esbuild": "^0.15.0",
+		"eslint": "^8.22.0",
+		"eslint-config-xo": "^0.42.0",
+		"eslint-config-xo-typescript": "^0.53.0",
+		"typescript": "^4.8.0"
 	},
 	"exports": {
 		".": {
@@ -37,10 +37,11 @@
 		"url": "git+https://github.com/oscarpalmer/timer.git"
 	},
 	"scripts": {
-    "build": "esbuild ./src/index.ts --bundle --target=es2020 --platform=browser --outfile=./dist/timer.js --format=esm",
+		"build": "esbuild ./src/index.ts --bundle --target=es2020 --platform=browser --outfile=./dist/timer.js --format=esm",
 		"watch": "esbuild ./src/index.ts --bundle --target=es2020 --platform=browser --outfile=./dist/timer.js --format=esm --watch"
 	},
 	"type": "module",
+	"types": "src/index.d.ts",
 	"unpkg": "dist/timer.js",
-	"version": "0.4.0"
-}
+	"version": "0.7.0"
+}

package/src/index.d.ts

@@ -1,18 +1 @@
-type RepeatedCallback = (index: number) => void;
-type WaitedCallback = () => void;
-
-interface Timed<Callback> {
-	get active(): boolean;
-	constructor(callback: Callback, time: number, count: number): void;
-	restart(): void;
-	start(): void;
-	stop(): void;
-}
-
-export interface Repeated extends Timed<RepeatedCallback> {}
-export interface Waited extends Timed<WaitedCallback> {}
-
-export interface Timer {
-	repeated(callback: RepeatedCallback, time: number, count: number): Repeated;
-	waited(callback: WaitedCallback, time: number): Waited;
-}
+export * from './index';

package/src/index.ts

@@ -2,7 +2,7 @@ type RepeatedCallback = (index: number) => void;
 type TimerType = 'repeated' | 'waited';
 type WaitedCallback = () => void;
 
-const milliseconds = 1000 / 60;
+const milliseconds = Math.round(1000 / 60);
 
 abstract class Timed<Callback> {
 	private readonly callback: Callback;
@@ -12,6 +12,9 @@ abstract class Timed<Callback> {
 	private readonly time: number;
 	private readonly type: TimerType;
 
+	/**
+	 * Is the timer active?
+	 */
 	get active(): boolean {
 		return this.running;
 	}
@@ -35,7 +38,10 @@ abstract class Timed<Callback> {
 		this.count = count;
 	}
 
-	restart(): Timed<Callback> {
+	/**
+	 * Restart timer
+	 */
+	restart(): this {
 		this.stop();
 
 		Timed.run(this as never);
@@ -43,7 +49,10 @@ abstract class Timed<Callback> {
 		return this;
 	}
 
-	start(): Timed<Callback> {
+	/**
+	 * Start timer
+	 */
+	start(): this {
 		if (this.running) {
 			return this;
 		}
@@ -53,7 +62,10 @@ abstract class Timed<Callback> {
 		return this;
 	}
 
-	stop(): Timed<Callback> {
+	/**
+	 * Stop timer
+	 */
+	stop(): this {
 		this.running = false;
 
 		if (typeof this.frame === 'undefined') {
@@ -109,24 +121,34 @@ abstract class Timed<Callback> {
 	}
 }
 
+/**
+ * A repeated timer
+ */
 export class Repeated extends Timed<RepeatedCallback> {
 	constructor(callback: RepeatedCallback, time: number, count: number) {
 		super('repeated', callback, time, count);
 	}
 }
 
+/**
+ * A waited timer
+ */
 export class Waited extends Timed<WaitedCallback> {
 	constructor(callback: WaitedCallback, time: number) {
 		super('waited', callback, time, 1);
 	}
 }
 
-export const Timer = {
-	repeat: (callback: RepeatedCallback, time: number, count: number): Repeated => {
-		return (new Repeated(callback, time, count)).start();
-	},
+/**
+ * Create and start a new repeated timer
+ */
+export function repeat(callback: RepeatedCallback, time: number, count: number): Repeated {
+	return (new Repeated(callback, time, count)).start();
+}
 
-	wait: (callback: WaitedCallback, time: number): Waited => {
-		return (new Waited(callback, time)).start();
-	},
+/**
+ * Create and start a new waited timer
+ */
+export function wait(callback: WaitedCallback, time: number): Waited {
+	return (new Waited(callback, time)).start();
 }

package/test/test.js

@@ -1,12 +1,12 @@
-import {Repeated, Timer, Waited} from '../dist/timer.js';
+import {repeat, wait, Repeated, Waited} from '../dist/timer.js';
 
-describe('Timer, factory', function () {
+describe('Functions', function () {
   it('should create and start a repeated timer', function () {
-		chai.assert.ok(Timer.repeat(() => {}, 0, 2) instanceof Repeated);
+		chai.assert.ok(repeat(() => {}, 0, 2) instanceof Repeated);
 	});
 
 	it('should create and start a waited timer', function () {
-		chai.assert.ok(Timer.wait(() => {}, 0) instanceof Waited);
+		chai.assert.ok(wait(() => {}, 0) instanceof Waited);
 	});
 });
 
@@ -28,11 +28,11 @@ describe('Timer, Repeated', function () {
 		it('should run as many times as set', function (done) {
 			let value = 0;
 
-			Timer.repeat(() => {
+			repeat(() => {
 				value += 1;
 			}, 25, 10);
 
-			Timer.wait(() => {
+			wait(() => {
 				chai.assert.equal(value, 10);
 
 				done();
@@ -42,15 +42,15 @@ describe('Timer, Repeated', function () {
 		it('should run until canceled', function (done) {
 			let value = 0;
 
-			const repeated = Timer.repeat(() => {
+			const repeated = repeat(() => {
 				value += 1;
 			}, 25, 10);
 
-			Timer.wait(() => {
+			wait(() => {
 				repeated.stop();
 			}, 125);
 
-			Timer.wait(() => {
+			wait(() => {
 				chai.assert.ok(value < 10);
 
 				done();
@@ -87,11 +87,11 @@ describe('Timer, Repeated & Waited', function () {
 				value = 1234;
 			}, 125);
 	
-			Timer.wait(() => {
+			wait(() => {
 				waited.stop();
 			}, 250);
 	
-			Timer.wait(() => {
+			wait(() => {
 				chai.assert.equal(value, 0);
 	
 				done();
@@ -107,11 +107,11 @@ describe('Timer, Repeated & Waited', function () {
 	
 			waited.start();
 	
-			Timer.wait(() => {
+			wait(() => {
 				waited.restart();
 			}, 250);
 	
-			Timer.wait(() => {
+			wait(() => {
 				chai.assert.equal(value, 2);
 	
 				done();