@oscarpalmer/timer 0.5.0 → 0.6.0

package/.eslintrc.json

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

package/README.md

@@ -4,4 +4,4 @@ A better timer?
 
 ## License
 
-[MI licensed](LICENSE), natch :blush:
+[MIT licensed](LICENSE), natch :blush:

package/dist/timer.js

@@ -93,16 +93,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

@@ -10,9 +10,9 @@
 		"@typescript-eslint/eslint-plugin": "^5.30.0",
 		"@typescript-eslint/parser": "^5.30.0",
 		"esbuild": "^0.14.0",
-		"eslint": "^8.19.0",
+		"eslint": "^8.20.0",
 		"eslint-config-xo": "^0.41.0",
-		"eslint-config-xo-typescript": "^0.51.0",
+		"eslint-config-xo-typescript": "^0.52.0",
 		"typescript": "^4.7.0"
 	},
 	"exports": {
@@ -43,5 +43,5 @@
 	"type": "module",
 	"types": "src/index.d.ts",
 	"unpkg": "dist/timer.js",
-	"version": "0.5.0"
+	"version": "0.6.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

@@ -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();