@byloth/core 2.1.6 → 2.1.8

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

@@ -1,3 +1,4 @@
+import type { Callback } from "../types.js";
 import type { FulfilledHandler, PromiseExecutor, RejectedHandler } from "./types.js";
 
 /**
@@ -241,11 +242,12 @@ export default class SmartPromise<T = void> implements Promise<T>
      *
      * @returns A new {@link Promise} resolved or rejected based on the callbacks.
      */
-    public then<F = T, R = never>(onFulfilled: FulfilledHandler<T, F>, onRejected: RejectedHandler<unknown, R>)
-        : Promise<F | R>;
     public then<F = T, R = never>(
-        onFulfilled?: FulfilledHandler<T, F> | null,
-        onRejected?: RejectedHandler<unknown, R> | null): Promise<F | R>
+        onFulfilled: FulfilledHandler<T, F>, onRejected: RejectedHandler<unknown, R>
+    ): Promise<F | R>;
+    public then<F = T, R = never>(
+        onFulfilled?: FulfilledHandler<T, F> | null, onRejected?: RejectedHandler<unknown, R> | null
+    ): Promise<F | R>
     {
         return this._promise.then(onFulfilled, onRejected);
     }
@@ -332,7 +334,7 @@ export default class SmartPromise<T = void> implements Promise<T>
      *
      * @returns A new {@link Promise} that executes the callback once the promise is settled.
      */
-    public finally(onFinally?: (() => void) | null): Promise<T>
+    public finally(onFinally?: Callback | null): Promise<T>
     {
         return this._promise.finally(onFinally);
     }

package/src/models/timers/clock.ts

@@ -1,7 +1,8 @@
 import { TimeUnit } from "../../utils/date.js";
 
-import Publisher from "../callbacks/publisher.js";
+import type Publisher from "../callbacks/publisher.js";
 import { FatalErrorException, RangeException, RuntimeException } from "../exceptions/index.js";
+import type { Callback } from "../types.js";
 
 import GameLoop from "./game-loop.js";
 
@@ -136,7 +137,7 @@ export default class Clock extends GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onTick(callback: (elapsedTime: number) => void, tickStep = 0): () => void
+    public onTick(callback: (elapsedTime: number) => void, tickStep = 0): Callback
     {
         if (tickStep < 0) { throw new RangeException("The tick step must be a non-negative number."); }
         if (tickStep === 0) { return this._publisher.subscribe("tick", callback); }

package/src/models/timers/countdown.ts

@@ -1,8 +1,9 @@
 import { TimeUnit } from "../../utils/date.js";
 
-import Publisher from "../callbacks/publisher.js";
+import type Publisher from "../callbacks/publisher.js";
 import { FatalErrorException, RangeException, RuntimeException } from "../exceptions/index.js";
-import { DeferredPromise, SmartPromise } from "../promises/index.js";
+import type { SmartPromise } from "../promises/index.js";
+import { DeferredPromise } from "../promises/index.js";
 import type { Callback } from "../types.js";
 
 import GameLoop from "./game-loop.js";
@@ -227,7 +228,7 @@ export default class Countdown extends GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onExpire(callback: () => void): () => void
+    public onExpire(callback: Callback): Callback
     {
         return this._publisher.subscribe("expire", callback);
     }
@@ -256,7 +257,7 @@ export default class Countdown extends GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onTick(callback: (remainingTime: number) => void, tickStep = 0): () => void
+    public onTick(callback: (remainingTime: number) => void, tickStep = 0): Callback
     {
         if (tickStep < 0) { throw new RangeException("The tick step must be a non-negative number."); }
         if (tickStep === 0) { return this._publisher.subscribe("tick", callback); }

package/src/models/timers/game-loop.ts

@@ -3,6 +3,7 @@ import { isBrowser } from "../../helpers.js";
 
 import Publisher from "../callbacks/publisher.js";
 import { FatalErrorException, RuntimeException } from "../exceptions/index.js";
+import type { Callback } from "../types.js";
 
 interface GameLoopEventsMap
 {
@@ -102,7 +103,7 @@ export default class GameLoop
      * Depending on the current environment, it could use the
      * {@link requestAnimationFrame} or the {@link setInterval} function.
      */
-    protected readonly _start: () => void;
+    protected readonly _start: Callback;
 
     /**
      * The internal method actually responsible for stopping the game loop.
@@ -110,7 +111,7 @@ export default class GameLoop
      * Depending on the current environment, it could use the
      * {@link cancelAnimationFrame} or the {@link clearInterval} function.
      */
-    protected readonly _stop: () => void;
+    protected readonly _stop: Callback;
 
     /**
      * Initializes a new instance of the {@link GameLoop} class.
@@ -235,7 +236,7 @@ export default class GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onStart(callback: () => void): () => void
+    public onStart(callback: Callback): Callback
     {
         return this._publisher.subscribe("start", callback);
     }
@@ -256,7 +257,7 @@ export default class GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onStop(callback: () => void): () => void
+    public onStop(callback: Callback): Callback
     {
         return this._publisher.subscribe("stop", callback);
     }

package/src/utils/async.ts

@@ -1,3 +1,5 @@
+import { SmartPromise } from "../models/index.js";
+
 /**
  * Returns a promise that resolves after a certain number of milliseconds.  
  * It can be used to pause or delay the execution of an asynchronous function.
@@ -15,11 +17,11 @@
  *
  * @param milliseconds The number of milliseconds to wait before resolving the promise.
  *
- * @returns A {@link Promise} that resolves after the specified number of milliseconds.
+ * @returns A {@link SmartPromise} that resolves after the specified number of milliseconds.
  */
-export function delay(milliseconds: number): Promise<void>
+export function delay(milliseconds: number): SmartPromise<void>
 {
-    return new Promise((resolve) => setTimeout(resolve, milliseconds));
+    return new SmartPromise((resolve) => setTimeout(resolve, milliseconds));
 }
 
 /**
@@ -39,11 +41,11 @@ export function delay(milliseconds: number): Promise<void>
  *
  * ---
  *
- * @returns A {@link Promise} that resolves on the next animation frame.
+ * @returns A {@link SmartPromise} that resolves on the next animation frame.
  */
-export function nextAnimationFrame(): Promise<void>
+export function nextAnimationFrame(): SmartPromise<void>
 {
-    return new Promise((resolve) => requestAnimationFrame(() => resolve()));
+    return new SmartPromise((resolve) => requestAnimationFrame(() => resolve()));
 }
 
 /**
@@ -64,9 +66,9 @@ export function nextAnimationFrame(): Promise<void>
  *
  * ---
  *
- * @returns A {@link Promise} that resolves on the next microtask.
+ * @returns A {@link SmartPromise} that resolves on the next microtask.
  */
-export function yieldToEventLoop(): Promise<void>
+export function yieldToEventLoop(): SmartPromise<void>
 {
-    return new Promise((resolve) => setTimeout(resolve));
+    return new SmartPromise((resolve) => setTimeout(resolve));
 }

package/src/utils/date.ts

@@ -174,8 +174,9 @@ export function dateDifference(start: number | string | Date, end: number | stri
  *
  * @returns A {@link SmartIterator} object that generates the dates in the range.
  */
-export function dateRange(start: number | string | Date, end: number | string | Date, step = TimeUnit.Day)
-    : SmartIterator<Date>
+export function dateRange(
+    start: number | string | Date, end: number | string | Date, step = TimeUnit.Day
+): SmartIterator<Date>
 {
     start = new Date(start);
     end = new Date(end);
@@ -271,3 +272,14 @@ export function getWeek(date: number | string | Date, firstDay = WeekDay.Sunday)
 
     return dateRound(new Date(firstDayTime));
 }
+
+export function getMonth(date: number | string | Date): Date
+{
+    date = new Date(date);
+    return new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth()));
+}
+export function getYear(date: number | string | Date): Date
+{
+    date = new Date(date);
+    return new Date(Date.UTC(date.getUTCFullYear()));
+}

package/src/utils/dom.ts

@@ -1,3 +1,5 @@
+import { SmartPromise } from "../models/index.js";
+
 /**
  * Appends a script element to the document body.  
  * It can be used to load external scripts dynamically.
@@ -15,11 +17,11 @@
  * @param scriptType The type of the script to load. Default is `"text/javascript"`.
  *
  * @returns
- * A {@link Promise} that resolves when the script has been loaded successfully or rejects if an error occurs.
+ * A {@link SmartPromise} that resolves when the script has been loaded successfully or rejects if an error occurs.
  */
-export function loadScript(scriptUrl: string, scriptType = "text/javascript"): Promise<void>
+export function loadScript(scriptUrl: string, scriptType = "text/javascript"): SmartPromise<void>
 {
-    return new Promise<void>((resolve, reject) =>
+    return new SmartPromise<void>((resolve, reject) =>
     {
         const script = document.createElement("script");