@develia/commons 0.5.0 → 0.6.1

package/src/triggers.ts

@@ -7,7 +7,8 @@ import type {Nullable, Supplier} from './types.js';
  */
 export class TimeTrigger<T> {
     private callback: Supplier<T | Promise<T>>;
-    private interval: TimeSpan;
+    /** Time that must pass between two runs. */
+    public interval: TimeSpan;
     private lastRunTime: Nullable<number>;
 
     public constructor(callback: Supplier<T | Promise<T>>, interval: TimeSpan) {
@@ -46,19 +47,6 @@ export class TimeTrigger<T> {
         this.callback = callback;
     }
 
-    /**
-     * Gets the configured time interval.
-     */
-    public getInterval(): TimeSpan {
-        return this.interval;
-    }
-
-    /**
-     * Replaces the configured time interval.
-     */
-    public setInterval(interval: TimeSpan): void {
-        this.interval = interval;
-    }
 
 
 }
@@ -68,12 +56,12 @@ export class TimeTrigger<T> {
  */
 export class CountTrigger<T> {
     private callback: Supplier<T | Promise<T>>;
-    private interval: number = 1;
+    private _interval: number = 1;
     private checkCount: number = 0;
 
     public constructor(callback: Supplier<T | Promise<T>>, interval: number) {
         this.callback = callback;
-        this.setInterval(interval);
+        this.interval = interval;
     }
 
     /**
@@ -82,7 +70,7 @@ export class CountTrigger<T> {
     public async check(): Promise<Result<T>> {
         this.checkCount++;
 
-        if (this.checkCount >= this.interval) {
+        if (this.checkCount >= this._interval) {
             return {success: true, output: await this.trigger()};
         }
 
@@ -105,22 +93,20 @@ export class CountTrigger<T> {
     }
 
     /**
-     * Gets the configured check interval.
+     * Number of checks after which the callback runs.
      */
-    public getInterval(): number {
-        return this.interval;
+    public get interval(): number {
+        return this._interval;
     }
 
     /**
-     * Replaces the configured check interval.
-     *
      * @throws {RangeError} When the interval is less than one.
      */
-    public setInterval(interval: number): void {
+    public set interval(interval: number) {
         if (interval < 1) {
             throw new RangeError('Interval must be greater than zero.');
         }
 
-        this.interval = interval;
+        this._interval = interval;
     }
 }

package/src/uuid.ts

@@ -11,7 +11,7 @@ const MAX_V7_MILLISECONDS = 0xffffffffffff;
  * such as `019a4f8b-4bae-7d2e-9f10-4a5b6c7d8e9f`.
  *
  * It serializes to its string with `JSON.stringify`, so DTOs carry it as text; read those
- * strings back with {@link Uuid.parse} or {@link Uuid.parseOrThrow}.
+ * strings back with {@link Uuid.parse} or {@link Uuid.tryParse}.
  */
 export default class Uuid {
     private readonly value: string;
@@ -73,44 +73,44 @@ export default class Uuid {
     /**
      * Reads a UUID in canonical form, in any letter case, as {@link Uuid.isValid} accepts it.
      *
-     * @returns The UUID, or `null` when the value is not one.
+     * @throws {SyntaxError} If the value is not a UUID.
      */
-    static parse(value: unknown): Nullable<Uuid> {
-        if (typeof value !== 'string' || !Uuid.isValid(value)) {
-            return null;
+    static parse(value: string): Uuid {
+        const uuid = Uuid.tryParse(value);
+        if (uuid === undefined) {
+            throw new SyntaxError(`Invalid UUID "${value}".`);
         }
 
-        return new Uuid(value.toLowerCase());
+        return uuid;
     }
 
     /**
-     * Reads a UUID in canonical form, in any letter case.
+     * Reads a UUID in canonical form, in any letter case, as {@link Uuid.isValid} accepts it.
      *
-     * @throws {SyntaxError} If the value is not a UUID.
+     * @returns The UUID, or `undefined` when the value is not one.
      */
-    static parseOrThrow(value: string): Uuid {
-        const uuid = Uuid.parse(value);
-        if (uuid === null) {
-            throw new SyntaxError(`Invalid UUID "${value}".`);
+    static tryParse(value: unknown): Uuid | undefined {
+        if (typeof value !== 'string' || !Uuid.isValid(value)) {
+            return undefined;
         }
 
-        return uuid;
+        return new Uuid(value.toLowerCase());
     }
 
     /**
-     * Returns the RFC 9562 version, from 1 to 8, or 0 for the Nil UUID and 15 for the Max UUID.
+     * The RFC 9562 version, from 1 to 8, or 0 for the Nil UUID and 15 for the Max UUID.
      */
-    getVersion(): number {
+    get version(): number {
         return Number.parseInt(this.value.charAt(14), 16);
     }
 
     /**
-     * Returns the moment a version 7 UUID encodes, with millisecond precision.
+     * The moment a version 7 UUID encodes, with millisecond precision.
      *
-     * @returns The moment, or `null` for other versions.
+     * It is `null` for other versions.
      */
-    getDate(): Nullable<Date> {
-        if (this.getVersion() !== 7) {
+    get date(): Nullable<Date> {
+        if (this.version !== 7) {
             return null;
         }