@byloth/core 2.0.0-rc.3 → 2.0.0-rc.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.0.0-rc.3",
+  "version": "2.0.0-rc.5",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -47,21 +47,18 @@
   },
   "types": "./src/index.ts",
   "devDependencies": {
-    "@byloth/eslint-config-typescript": "^2.8.3",
-    "@types/node": "^20.16.5",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.57.1",
+    "@byloth/eslint-config-typescript": "^3.0.1",
+    "@types/node": "^20.17.6",
     "husky": "^9.1.6",
-    "typescript": "^5.6.2",
-    "vite": "^5.4.7"
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10"
   },
   "scripts": {
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview",
     "typecheck": "tsc",
-    "lint": "eslint --ext .cjs,.js,.json,.ts --ignore-path .gitignore .",
+    "lint": "eslint .",
     "test": "vitest",
     "ci": "pnpm install --frozen-lockfile"
   }

package/src/helpers.ts

@@ -1,3 +1,10 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+
+// @ts-ignore
 export const isBrowser = ((typeof window !== "undefined") && (typeof window.document !== "undefined"));
+
+// @ts-ignore
 export const isNode = ((typeof process !== "undefined") && (process.versions?.node));
+
+// @ts-ignore
 export const isWebWorker = ((typeof self === "object") && (self.constructor?.name === "DedicatedWorkerGlobalScope"));

package/src/index.ts

@@ -1,4 +1,4 @@
-export const VERSION = "2.0.0-rc.3";
+export const VERSION = "2.0.0-rc.5";
 
 export type { Constructor, Interval, Timeout } from "./core/types.js";
 
@@ -29,6 +29,7 @@ export {
     SmartIterator,
     SmartAsyncIterator,
     SmartPromise,
+    Thenable,
     TimeoutException,
     TimedPromise,
     TypeException,

package/src/models/aggregators/aggregated-async-iterator.ts

@@ -204,11 +204,11 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
         });
     }
 
-    public async find(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>): Promise<ReducedIterator<K, T | void>>;
+    public async find(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>): Promise<ReducedIterator<K, T | undefined>>;
     public async find<S extends T>(predicate: MaybeAsyncKeyedTypeGuardIteratee<K, T, S>)
-        : Promise<ReducedIterator<K, S | void>>;
+        : Promise<ReducedIterator<K, S | undefined>>;
 
-    public async find(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>): Promise<ReducedIterator<K, T | void>>
+    public async find(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>): Promise<ReducedIterator<K, T | undefined>>
     {
         const values = new Map<K, [number, T | undefined]>();
 
@@ -347,5 +347,5 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
         return groups;
     }
 
-    public get [Symbol.toStringTag]() { return "AggregatedAsyncIterator"; }
+    public readonly [Symbol.toStringTag]: string = "AggregatedAsyncIterator";
 }

package/src/models/aggregators/aggregated-iterator.ts

@@ -192,9 +192,9 @@ export default class AggregatedIterator<K extends PropertyKey, T>
         });
     }
 
-    public find(predicate: KeyedIteratee<K, T, boolean>): ReducedIterator<K, T | void>;
-    public find<S extends T>(predicate: KeyedTypeGuardIteratee<K, T, S>): ReducedIterator<K, S | void>;
-    public find(predicate: KeyedIteratee<K, T, boolean>): ReducedIterator<K, T | void>
+    public find(predicate: KeyedIteratee<K, T, boolean>): ReducedIterator<K, T | undefined>;
+    public find<S extends T>(predicate: KeyedTypeGuardIteratee<K, T, S>): ReducedIterator<K, S | undefined>;
+    public find(predicate: KeyedIteratee<K, T, boolean>): ReducedIterator<K, T | undefined>
     {
         const values = new Map<K, [number, T | undefined]>();
 
@@ -337,5 +337,5 @@ export default class AggregatedIterator<K extends PropertyKey, T>
         return groups;
     }
 
-    public get [Symbol.toStringTag]() { return "AggregatedIterator"; }
+    public readonly [Symbol.toStringTag]: string = "AggregatedIterator";
 }

package/src/models/aggregators/reduced-iterator.ts

@@ -209,5 +209,5 @@ export default class ReducedIterator<K extends PropertyKey, T>
         return Object.fromEntries(this.items()) as Record<K, T>;
     }
 
-    public get [Symbol.toStringTag]() { return "ReducedIterator"; }
+    public readonly [Symbol.toStringTag]: string = "ReducedIterator";
 }

package/src/models/exceptions/core.ts

@@ -39,7 +39,7 @@ export default class Exception extends Error
         }
     }
 
-    public get [Symbol.toStringTag]() { return "Exception"; }
+    public readonly [Symbol.toStringTag]: string = "Exception";
 }
 
 export class FatalErrorException extends Exception
@@ -55,7 +55,7 @@ export class FatalErrorException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "FatalErrorException"; }
+    public readonly [Symbol.toStringTag]: string = "FatalErrorException";
 }
 export class NotImplementedException extends FatalErrorException
 {
@@ -69,5 +69,5 @@ export class NotImplementedException extends FatalErrorException
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "NotImplementedException"; }
+    public 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 get [Symbol.toStringTag]() { return "FileException"; }
+    public readonly [Symbol.toStringTag]: string = "FileException";
 }
 export class FileExistsException extends FileException
 {
@@ -16,7 +16,7 @@ export class FileExistsException extends FileException
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "FileExistsException"; }
+    public readonly [Symbol.toStringTag]: string = "FileExistsException";
 }
 export class FileNotFoundException extends FileException
 {
@@ -25,7 +25,7 @@ export class FileNotFoundException extends FileException
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "FileNotFoundException"; }
+    public readonly [Symbol.toStringTag]: string = "FileNotFoundException";
 }
 
 export class KeyException extends Exception
@@ -35,7 +35,7 @@ export class KeyException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "KeyException"; }
+    public readonly [Symbol.toStringTag]: string = "KeyException";
 }
 export class NetworkException extends Exception
 {
@@ -44,7 +44,7 @@ export class NetworkException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "NetworkException"; }
+    public readonly [Symbol.toStringTag]: string = "NetworkException";
 }
 export class PermissionException extends Exception
 {
@@ -53,7 +53,7 @@ export class PermissionException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "PermissionException"; }
+    public readonly [Symbol.toStringTag]: string = "PermissionException";
 }
 export class ReferenceException extends Exception
 {
@@ -62,7 +62,7 @@ export class ReferenceException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "ReferenceException"; }
+    public readonly [Symbol.toStringTag]: string = "ReferenceException";
 }
 
 export class RuntimeException extends Exception
@@ -72,7 +72,7 @@ export class RuntimeException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "RuntimeException"; }
+    public readonly [Symbol.toStringTag]: string = "RuntimeException";
 }
 export class EnvironmentException extends RuntimeException
 {
@@ -81,7 +81,7 @@ export class EnvironmentException extends RuntimeException
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "EnvironmentException"; }
+    public readonly [Symbol.toStringTag]: string = "EnvironmentException";
 }
 
 export class TimeoutException extends Exception
@@ -91,7 +91,7 @@ export class TimeoutException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "TimeoutException"; }
+    public readonly [Symbol.toStringTag]: string = "TimeoutException";
 }
 export class TypeException extends Exception
 {
@@ -100,7 +100,7 @@ export class TypeException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "TypeException"; }
+    public readonly [Symbol.toStringTag]: string = "TypeException";
 }
 
 export class ValueException extends Exception
@@ -110,7 +110,7 @@ export class ValueException extends Exception
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "ValueException"; }
+    public readonly [Symbol.toStringTag]: string = "ValueException";
 }
 export class RangeException extends ValueException
 {
@@ -119,7 +119,7 @@ export class RangeException extends ValueException
         super(message, cause, name);
     }
 
-    public get [Symbol.toStringTag]() { return "RangeException"; }
+    public readonly [Symbol.toStringTag]: string = "RangeException";
 }
 
 export { Exception };

package/src/models/game-loop.ts

@@ -1,11 +1,11 @@
+import type { Interval } from "../core/types.js";
 import { isBrowser } from "../helpers.js";
-import { TimeUnit } from "../utils/date.js";
 
 import { FatalErrorException, RuntimeException } from "./exceptions/index.js";
 
 export default class GameLoop
 {
-    protected _handle?: number;
+    protected _handle?: number | Interval;
 
     protected _startTime: number;
     public get startTime(): number
@@ -27,7 +27,7 @@ export default class GameLoop
     protected _start: () => void;
     protected _stop: () => void;
 
-    public constructor(callback: FrameRequestCallback, fpsIfNotBrowser = 30)
+    public constructor(callback: FrameRequestCallback, msIfNotBrowser = 40)
     {
         this._startTime = 0;
         this._isRunning = false;
@@ -41,24 +41,22 @@ export default class GameLoop
                 this._handle = window.requestAnimationFrame(this._start);
             };
 
-            this._stop = () => window.cancelAnimationFrame(this._handle!);
+            this._stop = () => window.cancelAnimationFrame(this._handle as number);
         }
         else
         {
             // eslint-disable-next-line no-console
             console.warn(
                 "Not a browser environment detected. " +
-                `Using setInterval@${fpsIfNotBrowser}fps instead of requestAnimationFrame...`
+                `Using setInterval@${msIfNotBrowser}ms instead of requestAnimationFrame...`
             );
 
             this._start = () =>
             {
-                const delay = (TimeUnit.Second / fpsIfNotBrowser);
-
-                this._handle = (setInterval(() => callback(this.elapsedTime), delay) as unknown) as number;
+                this._handle = setInterval(() => callback(this.elapsedTime), msIfNotBrowser);
             };
 
-            this._stop = () => clearInterval(this._handle!);
+            this._stop = () => clearInterval(this._handle as Interval);
         }
     }
 
@@ -80,4 +78,6 @@ export default class GameLoop
         this._handle = undefined;
         this._isRunning = false;
     }
+
+    public readonly [Symbol.toStringTag]: string = "GameLoop";
 }

package/src/models/index.ts

@@ -28,7 +28,7 @@ import GameLoop from "./game-loop.js";
 
 export { SmartIterator, SmartAsyncIterator } from "./iterators/index.js";
 export { JSONStorage } from "./json/index.js";
-export { DeferredPromise, SmartPromise, TimedPromise } from "./promises/index.js";
+export { DeferredPromise, SmartPromise, Thenable, TimedPromise } from "./promises/index.js";
 
 import Publisher from "./publisher.js";
 

package/src/models/iterators/smart-async-iterator.ts

@@ -97,7 +97,6 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -112,7 +111,6 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -179,7 +177,6 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
             index += 1;
         }
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -216,11 +213,11 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
         });
     }
 
-    public drop(count: number): SmartAsyncIterator<T, R | void>
+    public drop(count: number): SmartAsyncIterator<T, R | undefined>
     {
         const iterator = this._iterator;
 
-        return new SmartAsyncIterator<T, R | void>(async function* ()
+        return new SmartAsyncIterator<T, R | undefined>(async function* ()
         {
             let index = 0;
 
@@ -241,11 +238,11 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
             }
         });
     }
-    public take(limit: number): SmartAsyncIterator<T, R | void>
+    public take(limit: number): SmartAsyncIterator<T, R | undefined>
     {
         const iterator = this._iterator;
 
-        return new SmartAsyncIterator<T, R | void>(async function* ()
+        return new SmartAsyncIterator<T, R | undefined>(async function* ()
         {
             let index = 0;
 
@@ -263,11 +260,10 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
         });
     }
 
-    public async find(predicate: MaybeAsyncIteratee<T, boolean>): Promise<T | void>
+    public async find(predicate: MaybeAsyncIteratee<T, boolean>): Promise<T | undefined>
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -309,7 +305,6 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -322,7 +317,6 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = await this._iterator.next();
@@ -354,7 +348,7 @@ export default class SmartAsyncIterator<T, R = void, N = undefined> implements A
         return Array.fromAsync(this as AsyncIterable<T>);
     }
 
-    public get [Symbol.toStringTag]() { return "SmartAsyncIterator"; }
+    public readonly [Symbol.toStringTag]: string = "SmartAsyncIterator";
 
     public [Symbol.asyncIterator](): SmartAsyncIterator<T, R, N> { return this; }
 }

package/src/models/iterators/smart-iterator.ts

@@ -37,7 +37,6 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -52,7 +51,6 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -119,7 +117,6 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
             index += 1;
         }
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -155,11 +152,11 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
         });
     }
 
-    public drop(count: number): SmartIterator<T, R | void>
+    public drop(count: number): SmartIterator<T, R | undefined>
     {
         const iterator = this._iterator;
 
-        return new SmartIterator<T, R | void>(function* ()
+        return new SmartIterator<T, R | undefined>(function* ()
         {
             let index = 0;
             while (index < count)
@@ -179,11 +176,11 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
             }
         });
     }
-    public take(limit: number): SmartIterator<T, R | void>
+    public take(limit: number): SmartIterator<T, R | undefined>
     {
         const iterator = this._iterator;
 
-        return new SmartIterator<T, R | void>(function* ()
+        return new SmartIterator<T, R | undefined>(function* ()
         {
             let index = 0;
             while (index < limit)
@@ -200,13 +197,12 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
         });
     }
 
-    public find(predicate: Iteratee<T, boolean>): T | void;
-    public find<S extends T>(predicate: TypeGuardIteratee<T, S>): S | void;
-    public find(predicate: Iteratee<T, boolean>): T | void
+    public find(predicate: Iteratee<T, boolean>): T | undefined;
+    public find<S extends T>(predicate: TypeGuardIteratee<T, S>): S | undefined;
+    public find(predicate: Iteratee<T, boolean>): T | undefined
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -248,7 +244,6 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -262,7 +257,6 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
     {
         let index = 0;
 
-        // eslint-disable-next-line no-constant-condition
         while (true)
         {
             const result = this._iterator.next();
@@ -294,7 +288,7 @@ export default class SmartIterator<T, R = void, N = undefined> implements Iterat
         return Array.from(this as Iterable<T>);
     }
 
-    public get [Symbol.toStringTag]() { return "SmartIterator"; }
+    public readonly [Symbol.toStringTag]: string = "SmartIterator";
 
     public [Symbol.iterator](): SmartIterator<T, R, N> { return this; }
 }

package/src/models/iterators/types.ts

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 
 import type { MaybePromise } from "../promises/types.js";
 

package/src/models/json/json-storage.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-trailing-spaces */
 
 import { isBrowser } from "../../helpers.js";
 import { EnvironmentException } from "../exceptions/index.js";
@@ -45,7 +44,7 @@ export default class JSONStorage
             {
                 return JSON.parse(propertyValue);
             }
-            catch (error)
+            catch
             {
                 // eslint-disable-next-line no-console
                 console.warn(
@@ -252,5 +251,5 @@ export default class JSONStorage
         this._persistent.removeItem(propertyName);
     }
 
-    public get [Symbol.toStringTag]() { return "JSONStorage"; }
+    public readonly [Symbol.toStringTag]: string = "JSONStorage";
 }

package/src/models/json/types.ts

@@ -1,3 +1,7 @@
 export type JSONArray = JSONValue[];
-export type JSONObject = { [key: string]: JSONValue };
+
+// @ts-expect-error - This is a circular reference to itself.
+export type JSONObject = Record<string, JSONValue>;
+
+// @ts-expect-error - This is a circular reference to itself.
 export type JSONValue = boolean | number | string | null | JSONObject | JSONArray;

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 get [Symbol.toStringTag]() { return "DeferredPromise"; }
+    public readonly [Symbol.toStringTag]: string = "DeferredPromise";
 }

package/src/models/promises/index.ts

@@ -1,5 +1,6 @@
 import DeferredPromise from "./deferred-promise.js";
 import SmartPromise from "./smart-promise.js";
+import Thenable from "./thenable.js";
 import TimedPromise from "./timed-promise.js";
 
-export { DeferredPromise, SmartPromise, TimedPromise };
+export { DeferredPromise, SmartPromise, Thenable, TimedPromise };

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

@@ -64,5 +64,5 @@ export default class SmartPromise<T = void> implements Promise<T>
         return this._promise.finally(onFinally);
     }
 
-    public get [Symbol.toStringTag]() { return "SmartPromise"; }
+    public readonly [Symbol.toStringTag]: string = "SmartPromise";
 }

package/src/models/promises/thenable.ts

@@ -0,0 +1,97 @@
+export default class Thenable<T> implements Promise<T>
+{
+    protected _onFulfilled: (result: T) => T;
+    protected _resolve(result: T): T
+    {
+        return this._onFulfilled(result);
+    }
+
+    public constructor()
+    {
+        this._onFulfilled = (result: T) => result;
+    }
+
+    public then(onFulfilled?: null): Thenable<T>;
+    public then<F = T>(onFulfilled: (result: T) => F, onRejected?: null): Thenable<F>;
+    public then<F = T, R = never>(onFulfilled: (result: T) => F, onRejected: (reason: unknown) => R)
+        : Thenable<F | R>;
+    public then<F = T, R = never>(onFulfilled?: ((result: T) => F) | null, onRejected?: ((reason: unknown) => R) | null)
+        : Thenable<F | R>
+    {
+        if (onRejected)
+        {
+            const _previousOnFulfilled = this._onFulfilled;
+            this._onFulfilled = (result: T) =>
+            {
+                try
+                {
+                    result = _previousOnFulfilled(result);
+
+                    return (onFulfilled!(result) as unknown) as T;
+                }
+                catch (error)
+                {
+                    return (onRejected(error) as unknown) as T;
+                }
+            };
+        }
+        else if (onFulfilled)
+        {
+            const _previousOnFulfilled = this._onFulfilled;
+            this._onFulfilled = (result: T) =>
+            {
+                result = _previousOnFulfilled(result);
+
+                return (onFulfilled(result) as unknown) as T;
+            };
+        }
+
+        return (this as unknown) as Thenable<F | R>;
+    }
+
+    public catch(onRejected?: null): Thenable<T>;
+    public catch<R = never>(onRejected: (reason: unknown) => R): Thenable<T | R>;
+    public catch<R = never>(onRejected?: ((reason: unknown) => R) | null): Thenable<T | R>
+    {
+        if (onRejected)
+        {
+            const _previousOnFulfilled = this._onFulfilled;
+            this._onFulfilled = (result) =>
+            {
+                try
+                {
+                    return _previousOnFulfilled(result);
+                }
+                catch (error)
+                {
+                    return (onRejected(error) as unknown) as T;
+                }
+            };
+        }
+
+        return this as Thenable<T | R>;
+    }
+
+    public finally(onFinally?: (() => void) | null): Thenable<T>
+    {
+        if (onFinally)
+        {
+            const _previousOnFulfilled = this._onFulfilled;
+            this._onFulfilled = (result) =>
+            {
+                try
+                {
+                    return _previousOnFulfilled(result);
+                }
+                finally
+                {
+                    onFinally();
+                }
+            };
+        }
+
+        return this;
+    }
+
+    public readonly [Symbol.toStringTag]: string = "Thenable";
+}

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

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