@byloth/core 2.0.0-rc.11 → 2.0.0-rc.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.0.0-rc.11",
+  "version": "2.0.0-rc.12",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -48,7 +48,7 @@
   "types": "./src/index.ts",
   "devDependencies": {
     "@byloth/eslint-config-typescript": "^3.0.3",
-    "@types/node": "^22.10.1",
+    "@types/node": "^22.10.2",
     "husky": "^9.1.7",
     "typescript": "^5.7.2",
     "vite": "^5.4.11"

package/src/index.ts

@@ -1,4 +1,4 @@
-export const VERSION = "2.0.0-rc.11";
+export const VERSION = "2.0.0-rc.12";
 
 export type { Constructor, Interval, Timeout } from "./core/types.js";
 
@@ -78,6 +78,7 @@ export {
     capitalize,
     chain,
     count,
+    Curve,
     delay,
     dateDifference,
     dateRange,

package/src/models/callbacks/callable-object.ts

@@ -2,16 +2,15 @@
 
 import type { Callback } from "./types.js";
 
-export const SmartFunction = (Function as unknown) as
-    new<T extends Callback<any[], any> = () => void>(...args: string[]) =>
-        (...args: Parameters<T>) => ReturnType<T>;
+export const SmartFunction = (Function as unknown) as new<A extends unknown[] = [], R = void>(...args: string[])
+    => (...args: A) => R;
 
 export default abstract class CallableObject<T extends Callback<any[], any> = () => void>
-    extends SmartFunction<T>
+    extends SmartFunction<Parameters<T>, ReturnType<T>>
 {
     public constructor()
     {
-        super(`return this.invoke(...arguments);`);
+        super(`return this._invoke(...arguments);`);
 
         const self = this.bind(this);
         Object.setPrototypeOf(this, self);
@@ -19,7 +18,7 @@ export default abstract class CallableObject<T extends Callback<any[], any> = ()
         return self as this;
     }
 
-    public abstract invoke(...args: Parameters<T>): ReturnType<T>;
+    protected abstract _invoke(...args: Parameters<T>): ReturnType<T>;
 
     public readonly [Symbol.toStringTag]: string = "CallableObject";
 }

package/src/models/callbacks/switchable-callback.ts

@@ -15,7 +15,7 @@ export default class SwitchableCallback<T extends Callback<any[], any> = Callbac
     protected _key: string;
     public get key(): string { return this._key; }
 
-    public readonly invoke: (...args: Parameters<T>) => ReturnType<T>;
+    protected readonly _invoke: (...args: Parameters<T>) => ReturnType<T>;
 
     public constructor()
     {
@@ -35,7 +35,7 @@ export default class SwitchableCallback<T extends Callback<any[], any> = Callbac
         this._isEnabled = true;
         this._key = "";
 
-        this.invoke = (...args: Parameters<T>): ReturnType<T> => this._callback(...args);
+        this._invoke = (...args: Parameters<T>): ReturnType<T> => this._callback(...args);
     }
 
     public enable(): void
@@ -106,5 +106,5 @@ export default class SwitchableCallback<T extends Callback<any[], any> = Callbac
         }
     }
 
-    public readonly [Symbol.toStringTag]: string = "SwitchableCallback";
+    public override readonly [Symbol.toStringTag]: string = "SwitchableCallback";
 }

package/src/models/exceptions/core.ts

@@ -55,7 +55,7 @@ export class FatalErrorException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "FatalErrorException";
+    public override readonly [Symbol.toStringTag]: string = "FatalErrorException";
 }
 export class NotImplementedException extends FatalErrorException
 {
@@ -69,5 +69,5 @@ export class NotImplementedException extends FatalErrorException
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "NotImplementedException";
+    public override readonly [Symbol.toStringTag]: string = "NotImplementedException";
 }

package/src/models/exceptions/index.ts

@@ -7,7 +7,7 @@ export class FileException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "FileException";
+    public override readonly [Symbol.toStringTag]: string = "FileException";
 }
 export class FileExistsException extends FileException
 {
@@ -16,7 +16,7 @@ export class FileExistsException extends FileException
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "FileExistsException";
+    public override readonly [Symbol.toStringTag]: string = "FileExistsException";
 }
 export class FileNotFoundException extends FileException
 {
@@ -25,7 +25,7 @@ export class FileNotFoundException extends FileException
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "FileNotFoundException";
+    public override readonly [Symbol.toStringTag]: string = "FileNotFoundException";
 }
 
 export class KeyException extends Exception
@@ -35,7 +35,7 @@ export class KeyException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "KeyException";
+    public override readonly [Symbol.toStringTag]: string = "KeyException";
 }
 export class NetworkException extends Exception
 {
@@ -44,7 +44,7 @@ export class NetworkException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "NetworkException";
+    public override readonly [Symbol.toStringTag]: string = "NetworkException";
 }
 export class PermissionException extends Exception
 {
@@ -53,7 +53,7 @@ export class PermissionException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "PermissionException";
+    public override readonly [Symbol.toStringTag]: string = "PermissionException";
 }
 export class ReferenceException extends Exception
 {
@@ -62,7 +62,7 @@ export class ReferenceException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "ReferenceException";
+    public override readonly [Symbol.toStringTag]: string = "ReferenceException";
 }
 
 export class RuntimeException extends Exception
@@ -72,7 +72,7 @@ export class RuntimeException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "RuntimeException";
+    public override readonly [Symbol.toStringTag]: string = "RuntimeException";
 }
 export class EnvironmentException extends RuntimeException
 {
@@ -81,7 +81,7 @@ export class EnvironmentException extends RuntimeException
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "EnvironmentException";
+    public override readonly [Symbol.toStringTag]: string = "EnvironmentException";
 }
 
 export class TimeoutException extends Exception
@@ -91,7 +91,7 @@ export class TimeoutException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "TimeoutException";
+    public override readonly [Symbol.toStringTag]: string = "TimeoutException";
 }
 export class TypeException extends Exception
 {
@@ -100,7 +100,7 @@ export class TypeException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "TypeException";
+    public override readonly [Symbol.toStringTag]: string = "TypeException";
 }
 
 export class ValueException extends Exception
@@ -110,7 +110,7 @@ export class ValueException extends Exception
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "ValueException";
+    public override readonly [Symbol.toStringTag]: string = "ValueException";
 }
 export class RangeException extends ValueException
 {
@@ -119,7 +119,7 @@ export class RangeException extends ValueException
         super(message, cause, name);
     }
 
-    public readonly [Symbol.toStringTag]: string = "RangeException";
+    public override readonly [Symbol.toStringTag]: string = "RangeException";
 }
 
 export { Exception };

package/src/models/promises/deferred-promise.ts

@@ -37,5 +37,5 @@ export default class DeferredPromise<T = void, F = T, R = never> extends SmartPr
         return this;
     }
 
-    public readonly [Symbol.toStringTag]: string = "DeferredPromise";
+    public override readonly [Symbol.toStringTag]: string = "DeferredPromise";
 }

package/src/models/promises/timed-promise.ts

@@ -27,5 +27,5 @@ export default class TimedPromise<T = void> extends SmartPromise<T>
         });
     }
 
-    public readonly [Symbol.toStringTag]: string = "TimedPromise";
+    public override readonly [Symbol.toStringTag]: string = "TimedPromise";
 }

package/src/models/timers/clock.ts

@@ -22,7 +22,7 @@ export default class Clock extends GameLoop
         this._publisher = new Publisher();
     }
 
-    public start(elapsedTime = 0): void
+    public override start(elapsedTime = 0): void
     {
         if (this._isRunning) { throw new RuntimeException("The clock has already been started."); }
 
@@ -31,7 +31,7 @@ export default class Clock extends GameLoop
         this._publisher.publish("start");
     }
 
-    public stop(): void
+    public override stop(): void
     {
         if (!(this._isRunning)) { throw new RuntimeException("The clock hadn't yet started."); }
 
@@ -65,5 +65,5 @@ export default class Clock extends GameLoop
         });
     }
 
-    public readonly [Symbol.toStringTag]: string = "Clock";
+    public override readonly [Symbol.toStringTag]: string = "Clock";
 }

package/src/models/timers/countdown.ts

@@ -64,7 +64,7 @@ export default class Countdown extends GameLoop
         this._deferrer = undefined;
     }
 
-    public start(remainingTime: number = this.duration): SmartPromise<void>
+    public override start(remainingTime: number = this.duration): SmartPromise<void>
     {
         if (this._isRunning) { throw new RuntimeException("The countdown has already been started."); }
         if (this._deferrer) { throw new FatalErrorException(); }
@@ -76,7 +76,7 @@ export default class Countdown extends GameLoop
 
         return this._deferrer;
     }
-    public stop(reason?: unknown): void
+    public override stop(reason?: unknown): void
     {
         this._deferrerStop(reason);
 
@@ -113,5 +113,5 @@ export default class Countdown extends GameLoop
         });
     }
 
-    public readonly [Symbol.toStringTag]: string = "Countdown";
+    public override readonly [Symbol.toStringTag]: string = "Countdown";
 }

package/src/utils/curve.ts

@@ -0,0 +1,27 @@
+import { SmartIterator } from "../models/index.js";
+
+export default class Curve
+{
+    public static Linear(values: number): SmartIterator<number>
+    {
+        const step = (1 / values);
+
+        return new SmartIterator<number>(function* ()
+        {
+            for (let index = 0; index < values; index += 1) { yield index * step; }
+        });
+    }
+    public static Exponential(values: number, base = 2): SmartIterator<number>
+    {
+        const steps = (values - 1);
+
+        return new SmartIterator<number>(function* ()
+        {
+            for (let index = 0; index < values; index += 1) { yield Math.pow(index / steps, base); }
+        });
+    }
+
+    private constructor() { /* ... */ }
+
+    public readonly [Symbol.toStringTag]: string = "Curve";
+}

package/src/utils/index.ts

@@ -1,3 +1,4 @@
+import Curve from "./curve.js";
 import Random from "./random.js";
 
 export { delay, nextAnimationFrame, yieldToEventLoop } from "./async.js";
@@ -7,4 +8,4 @@ export { chain, count, enumerate, range, shuffle, unique, zip } from "./iterator
 export { average, hash, sum } from "./math.js";
 export { capitalize } from "./string.js";
 
-export { Random };
+export { Curve, Random };