@develia/commons 0.4.14 → 0.4.15

package/dist/types/draft.d.ts

@@ -1,17 +1,85 @@
+/**
+ * Methods injected into a draft proxy in addition to the original object's properties.
+ *
+ * @template T - The shape of the wrapped object.
+ */
 type DraftMethods<T> = {
+    /**
+     * Apply pending changes to the original object.
+     *
+     * @param key - Optional property key. If provided, commits only that property.
+     *              If omitted, commits every modified property recursively.
+     * @returns `true` when a single-property commit was applied,
+     *          `false` when the property was not modified,
+     *          `void` when committing the whole draft.
+     */
     commit(key?: keyof T): boolean | void;
+    /**
+     * Discard pending changes, restoring values from the original object.
+     *
+     * @param key - Optional property key. If provided, rolls back only that property.
+     *              If omitted, rolls back every modified property recursively.
+     * @returns `true` when a single-property rollback was applied,
+     *          `false` when the property was not modified,
+     *          `void` when rolling back the whole draft.
+     */
     rollback(key?: keyof T): boolean | void;
+    /**
+     * Check whether the draft (or a specific property) has pending changes.
+     *
+     * @param key - Optional property key. If omitted, checks the whole draft.
+     * @returns `true` if there are pending changes.
+     */
     isModified(key?: keyof T): boolean;
+    /**
+     * Get the list of property keys with pending changes at this draft level.
+     *
+     * @returns Array of modified property keys (does not recurse into children).
+     */
     modifiedProps(): (keyof T)[];
+    /**
+     * Manually mark (or unmark) a property as modified.
+     * Primarily used by child drafts to notify their parent, but also
+     * available for advanced manual control.
+     *
+     * @param key - Property key to flag.
+     * @param modified - `true` to mark as modified (default), `false` to clear.
+     */
     setModified(key: keyof T, modified?: boolean): void;
 };
+/**
+ * A draft proxy: the original object's properties plus draft control methods.
+ *
+ * @template T - The shape of the wrapped object.
+ */
 export type Draft<T extends object> = T & DraftMethods<T>;
+/**
+ * Link from a child draft to its parent, used to propagate modification status.
+ */
 type ParentLink = {
+    /** Parent draft methods reference (we only need `setModified`). */
     parent: {
         setModified(key: PropertyKey, modified?: boolean): void;
     };
+    /** Key under which this draft is stored in the parent. */
     keyInParent: PropertyKey;
 };
+/**
+ * Create a draft proxy over `original`. The proxy exposes the same properties
+ * as the original (with nested objects wrapped as child drafts) plus the
+ * control methods `commit`, `rollback`, `isModified`, `modifiedProps` and
+ * `setModified`.
+ *
+ * Mutations on the draft do not affect the original until `commit()` is called.
+ * Nested mutations bubble up: modifying a deep property marks every ancestor
+ * draft as modified at the corresponding key.
+ *
+ * @template T - The shape of the wrapped object.
+ * @param original - The object to wrap. It will only be mutated on `commit()`.
+ * @param parentLink - Internal link used when this draft is a child of another.
+ *                     Do not pass manually.
+ * @returns A draft proxy over a deep copy of `original`.
+ */
 export default function draft<T extends object>(original: T, parentLink?: ParentLink): Draft<T>;
 export {};
 //# sourceMappingURL=draft.d.ts.map

package/dist/types/draft.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"draft.d.ts","sourceRoot":"","sources":["../../src/draft.ts"],"names":[],"mappings":"AAKA,KAAK,YAAY,CAAC,CAAC,IAAI;IAUnB,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAWtC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAQxC,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAOnC,aAAa,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAU7B,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACvD,CAAC;AAOF,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAK1D,KAAK,UAAU,GAAG;IAEd,MAAM,EAAE;QAAE,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAEpE,WAAW,EAAE,WAAW,CAAC;CAC5B,CAAC;AAsDF,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,CAAC,SAAS,MAAM,EAC1C,QAAQ,EAAE,CAAC,EACX,UAAU,CAAC,EAAE,UAAU,GACxB,KAAK,CAAC,CAAC,CAAC,CA6IV"}
+{"version":3,"file":"draft.d.ts","sourceRoot":"","sources":["../../src/draft.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,KAAK,YAAY,CAAC,CAAC,IAAI;IACnB;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAEtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAExC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAEnC;;;;OAIG;IACH,aAAa,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAE7B;;;;;;;OAOG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACvD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAE1D;;GAEG;AACH,KAAK,UAAU,GAAG;IACd,mEAAmE;IACnE,MAAM,EAAE;QAAE,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IACpE,0DAA0D;IAC1D,WAAW,EAAE,WAAW,CAAC;CAC5B,CAAC;AAsCF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,CAAC,SAAS,MAAM,EAC1C,QAAQ,EAAE,CAAC,EACX,UAAU,CAAC,EAAE,UAAU,GACxB,KAAK,CAAC,CAAC,CAAC,CA6IV"}

package/dist/types/index.d.ts

@@ -12,11 +12,14 @@ export { default as TimeSpan } from './timespan.js';
 export { default as Stopwatch } from './stopwatch.js';
 export { default as AsyncPoolExecutor } from './async-pool-executor.js';
 export { default as Lazy } from './lazy.js';
-export { default as from, From } from './from.js';
+export { default as from } from './collections/from.js';
 export { EventBus, Event } from './event-bus.js';
 export { default as draft } from './draft.js';
 export { default as CleanURLSearchParams } from './clean-url-search-params.js';
+/** @deprecated  */
 export { ajaxSubmit, ajaxSubmission, submitForm, formToObject } from './browser/index.js';
+/** @deprecated  */
 export * from './array.js';
+/** @deprecated  */
 export * from './collections/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAGnD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,0BAA0B,CAAC;AAGvE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAGtE,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAC,OAAO,IAAI,IAAI,EAAE,IAAI,EAAC,MAAM,WAAW,CAAC;AAChD,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAG/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAMxF,cAAc,YAAY,CAAC;AAE3B,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAGnD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,0BAA0B,CAAC;AAGvE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAGtE,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAG/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,YAAY,CAAC;AAG5C,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAC7E,mBAAmB;AACnB,OAAO,EAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAKxF,mBAAmB;AACnB,cAAc,YAAY,CAAC;AAC3B,mBAAmB;AACnB,cAAc,wBAAwB,CAAC"}

package/dist/types/key-value-pair.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Represents a pair of key and value.
+ *
+ * @template TKey The type of the key.
+ * @template TValue The type of the value.
+ */
 export default class KeyValuePair<TKey, TValue> {
     get value(): TValue;
     get key(): TKey;

package/dist/types/key-value-pair.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key-value-pair.d.ts","sourceRoot":"","sources":["../../src/key-value-pair.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM;IAC1C,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,GAAG,IAAI,IAAI,CAEd;IAED,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM;CAMvC"}
+{"version":3,"file":"key-value-pair.d.ts","sourceRoot":"","sources":["../../src/key-value-pair.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM;IAC1C,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,GAAG,IAAI,IAAI,CAEd;IAED,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM;CAMvC"}

package/dist/types/lazy.d.ts

@@ -1,4 +1,8 @@
 import type { Supplier } from "./types.js";
+/**
+ * Represents a lazy value that is created only when it is accessed for the first time.
+ * @template T The type of the lazy value.
+ */
 export default class Lazy<T> {
     private _valueCreated;
     private _value;

package/dist/types/lazy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lazy.d.ts","sourceRoot":"","sources":["../../src/lazy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,QAAQ,EAAC,MAAM,YAAY,CAAC;AAOnD,MAAM,CAAC,OAAO,OAAO,IAAI,CAAC,CAAC;IACvB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAc;gBAEjC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAI/B,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAW,KAAK,IAAI,CAAC,CAMpB;IAED,KAAK,IAAI,IAAI;CAIhB"}
+{"version":3,"file":"lazy.d.ts","sourceRoot":"","sources":["../../src/lazy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,QAAQ,EAAC,MAAM,YAAY,CAAC;AAGnD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI,CAAC,CAAC;IACvB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAc;gBAEjC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAI/B,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAW,KAAK,IAAI,CAAC,CAMpB;IAED,KAAK,IAAI,IAAI;CAIhB"}

package/dist/types/math.d.ts

@@ -1,3 +1,22 @@
+/**
+ * Linearly interpolates a number between two ranges.
+ *
+ * @param {number} n - The number to interpolate.
+ * @param {number} inMin - The minimum value of the input range.
+ * @param {number} inMax - The maximum value of the input range.
+ * @param {number} outMin - The minimum value of the output range.
+ * @param {number} outMax - The maximum value of the output range.
+ *
+ * @return {number} - The interpolated value.
+ */
 export declare function lerp(n: number, inMin: number, inMax: number, outMin: number, outMax: number): number;
+/**
+ * Clamps a number between a minimum and maximum value.
+ *
+ * @param {number} n - The value to be clamped.
+ * @param {number} min - The minimum value.
+ * @param {number} max - The maximum value.
+ * @return {number} The clamped value.
+ */
 export declare function clamp(n: number, min: number, max: number): number;
 //# sourceMappingURL=math.d.ts.map

package/dist/types/math.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../src/math.ts"],"names":[],"mappings":"AAWA,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpG;AAUD,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAMjE"}
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../src/math.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpG;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAMjE"}

package/dist/types/parse.d.ts

@@ -1,16 +1,137 @@
+/**
+ * Options for {@link parseBoolean}.
+ */
 export interface ParseBooleanOptions {
+    /**
+     * Additional strings to consider as `true`.
+     * These are matched case-insensitively.
+     * @example ["oui", "ja"]
+     */
     extraTruthy?: string[];
+    /**
+     * Additional strings to consider as `false`.
+     * These are matched case-insensitively.
+     * @example ["non", "nein"]
+     */
     extraFalsy?: string[];
 }
+/**
+ * Options for {@link parseInteger}.
+ */
 export interface ParseIntegerOptions {
+    /**
+     * Numeric base for conversion.
+     * @default 10
+     */
     radix?: number;
+    /**
+     * Thousands separator to strip before parsing.
+     * @example "." for "1.234.567" → 1234567
+     * @example "," for "1,234,567" → 1234567
+     */
     thousandsSeparator?: string;
 }
+/**
+ * Options for {@link parseDecimal}.
+ */
 export interface ParseDecimalOptions {
+    /**
+     * Character used as decimal point.
+     * @default "."
+     */
     decimalSeparator?: "." | ",";
+    /**
+     * Thousands separator to strip before parsing.
+     * @example "." for "1.234,56" (EU format)
+     * @example "," for "1,234.56" (US format)
+     */
     thousandsSeparator?: string;
 }
+/**
+ * Safely parses a value into an integer.
+ * Returns `null` if the value cannot be parsed.
+ *
+ * - `null` or `undefined` → `null`
+ * - `number` → returned as-is (floats are truncated)
+ * - `string` → parsed with the given options
+ *
+ * @param value - The value to parse.
+ * @param options - Optional parsing configuration.
+ * @returns The parsed integer, or `null` on failure.
+ *
+ * @example
+ * ```ts
+ * parseInteger(42)                                        // 42
+ * parseInteger(3.7)                                       // 3
+ * parseInteger(null)                                      // null
+ * parseInteger(undefined)                                 // null
+ * parseInteger("42")                                      // 42
+ * parseInteger("1.234.567", { thousandsSeparator: "." })  // 1234567
+ * parseInteger("FF", { radix: 16 })                       // 255
+ * parseInteger("abc")                                     // null
+ * ```
+ */
 export declare function parseInteger(value: string | number | null | undefined, options?: ParseIntegerOptions): number | null;
+/**
+ * Safely parses a value into a floating-point number.
+ * Returns `null` if the value cannot be parsed.
+ *
+ * - `null` or `undefined` → `null`
+ * - `number` → returned as-is (if finite)
+ * - `string` → parsed with the given options
+ *
+ * Supports custom decimal and thousands separators, making it suitable
+ * for both US (`1,234.56`) and EU (`1.234,56`) number formats.
+ *
+ * @param value - The value to parse.
+ * @param options - Optional parsing configuration.
+ * @returns The parsed float, or `null` on failure.
+ *
+ * @example
+ * ```ts
+ * parseDecimal(3.14)                                                       // 3.14
+ * parseDecimal(null)                                                       // null
+ * parseDecimal(undefined)                                                  // null
+ * parseDecimal("3.14")                                                     // 3.14
+ * parseDecimal("3,14", { decimalSeparator: "," })                          // 3.14
+ * parseDecimal("1.234,56", { decimalSeparator: ",", thousandsSeparator: "." }) // 1234.56
+ * parseDecimal("abc")                                                      // null
+ * ```
+ */
 export declare function parseDecimal(value: string | number | null | undefined, options?: ParseDecimalOptions): number | null;
+/**
+ * Safely parses a value into a boolean.
+ * Returns `null` if the value cannot be interpreted as boolean.
+ *
+ * - `null` or `undefined` → `null`
+ * - `boolean` → returned as-is
+ * - `number` → `0` is `false`, any other finite number is `true`
+ * - `string` → matched case-insensitively against known truthy/falsy values
+ *
+ * Default truthy: `"true"`, `"1"`, `"yes"`, `"si"`, `"sí"`, `"on"`
+ * Default falsy:  `"false"`, `"0"`, `"no"`, `"off"`
+ *
+ * @param value - The value to parse.
+ * @param options - Optional parsing configuration.
+ * @returns The parsed boolean, or `null` on failure.
+ *
+ * @example
+ * ```ts
+ * parseBoolean(true)                                    // true
+ * parseBoolean(false)                                   // false
+ * parseBoolean(1)                                       // true
+ * parseBoolean(0)                                       // false
+ * parseBoolean(null)                                    // null
+ * parseBoolean(undefined)                               // null
+ * parseBoolean("yes")                                   // true
+ * parseBoolean("no")                                    // false
+ * parseBoolean("sí")                                    // true
+ * parseBoolean("TRUE")                                  // true
+ * parseBoolean("oui")                                   // null
+ * parseBoolean("oui", { extraTruthy: ["oui"] })         // true
+ * parseBoolean("nein", { extraFalsy: ["nein"] })        // false
+ * parseBoolean("whatever")                              // null
+ * ```
+ */
 export declare function parseBoolean(value: string | number | boolean | null | undefined, options?: ParseBooleanOptions): boolean | null;
 //# sourceMappingURL=parse.d.ts.map

package/dist/types/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/parse.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,mBAAmB;IAMhC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAOvB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAKD,MAAM,WAAW,mBAAmB;IAKhC,KAAK,CAAC,EAAE,MAAM,CAAC;IAOf,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAKD,MAAM,WAAW,mBAAmB;IAKhC,gBAAgB,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;IAO7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAuCD,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACzC,OAAO,GAAE,mBAAwB,GAClC,MAAM,GAAG,IAAI,CAiBf;AAgCD,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACzC,OAAO,GAAE,mBAAwB,GAClC,MAAM,GAAG,IAAI,CAwBf;AA2CD,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,EACnD,OAAO,GAAE,mBAAwB,GAClC,OAAO,GAAG,IAAI,CAsBhB"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/parse.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAeD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACzC,OAAO,GAAE,mBAAwB,GAClC,MAAM,GAAG,IAAI,CAiBf;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACzC,OAAO,GAAE,mBAAwB,GAClC,MAAM,GAAG,IAAI,CAwBf;AASD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,EACnD,OAAO,GAAE,mBAAwB,GAClC,OAAO,GAAG,IAAI,CAsBhB"}

package/dist/types/string.d.ts

@@ -1,9 +1,60 @@
+/**
+ * Ensures that a given string has a specific prefix.
+ *
+ * @param {string} str - The string to ensure the prefix on.
+ * @param {string} prefix - The prefix to ensure on the string.
+ * @return {string} - The resulting string with the ensured prefix.
+ */
 export declare function ensurePrefix(str: string, prefix: string): string;
+/**
+ * Ensures that a string ends with a specified suffix.
+ *
+ * @param {string} str - The original string.
+ * @param {string} suffix - The suffix to ensure.
+ * @return {string} - The modified string with the suffix added if it was not already present.
+ */
 export declare function ensureSuffix(str: string, suffix: string): string;
+/**
+ * Formats a string using a template and provided arguments.
+ *
+ * @param {string} template - The template string containing placeholders.
+ * @param {any[]} args - Optional arguments to replace the placeholders in the template.
+ * @return {string} The formatted string.
+ */
 export declare function format(template: string, ...args: any[]): string;
+/**
+ * Converts a string to snake_case.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to snake_case.
+ */
 export declare function toSnakeCase(str: string): string;
+/**
+ * Converts a string to kebab-case.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to kebab-case.
+ */
 export declare function toKebabCase(str: string): string;
+/**
+ * Converts a string to camelCase.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to camelCase.
+ */
 export declare function toCamelCase(str: string): string;
+/**
+ * Converts a string to PascalCase.
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to PascalCase.
+ */
 export declare function toPascalCase(str: string): string;
+/**
+ * Converts a string to CONSTANT_CASE (a.k.a. SCREAMING_SNAKE_CASE).
+ *
+ * @param {string} str - The string to convert.
+ * @return {string} - The string converted to CONSTANT_CASE.
+ */
 export declare function toConstantCase(str: string): string;
 //# sourceMappingURL=string.d.ts.map

package/dist/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/string.ts"],"names":[],"mappings":"AAQA,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIhE;AAUD,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIhE;AASD,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAa/D;AAgCD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAQD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAQD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C;AAQD,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIhD;AAQD,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/string.ts"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIhE;AAGD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIhE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAa/D;AA0BD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD"}

package/dist/types/timer.d.ts

@@ -1,7 +1,14 @@
+/**
+ * A class representing a timer that executes a callback function at a specified interval.
+ */
 export default class Timer {
     private _callback;
     private _interval;
     private _intervalId;
+    /**
+     * @param callback Callback
+     * @param interval Seconds between calls
+     */
     constructor(callback: () => void, interval: number);
     get running(): boolean;
     get interval(): number;

package/dist/types/timer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timer.d.ts","sourceRoot":"","sources":["../../src/timer.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,OAAO,KAAK;IAEtB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAa;gBAMpB,QAAQ,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,MAAM;IAOlD,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAMzB;IAED,IAAI,QAAQ,IAAI,MAAM,IAAI,CAEzB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,EAI7B;IAGD,KAAK,IAAI,IAAI;IASb,IAAI,IAAI,IAAI;IAOZ,OAAO,IAAI,IAAI;CAIlB"}
+{"version":3,"file":"timer.d.ts","sourceRoot":"","sources":["../../src/timer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IAEtB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAa;IAEhC;;;OAGG;gBACS,QAAQ,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,MAAM;IAOlD,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAMzB;IAED,IAAI,QAAQ,IAAI,MAAM,IAAI,CAEzB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,EAI7B;IAGD,KAAK,IAAI,IAAI;IASb,IAAI,IAAI,IAAI;IAOZ,OAAO,IAAI,IAAI;CAIlB"}

package/dist/types/timespan.d.ts

@@ -1,47 +1,249 @@
+/**
+ * Represents a duration of time in milliseconds.
+ */
 export default class TimeSpan {
     milliseconds: number;
     private constructor();
+    /**
+     * Gets the time interval in seconds.
+     * @returns {number} The duration in seconds.
+     */
     seconds(): number;
+    /**
+     * Gets the time interval in minutes.
+     * @returns {number} The duration in minutes.
+     */
     minutes(): number;
+    /**
+     * Gets the time interval in hours.
+     * @returns {number} The duration in hours.
+     */
     hours(): number;
+    /**
+     * Gets the time interval in days.
+     * @returns {number} The duration in days.
+     */
     days(): number;
+    /**
+     * Gets the time interval in weeks.
+     * @returns {number} The duration in weeks.
+     */
     weeks(): number;
+    /**
+     * Creates a TimeSpan from a specified number of milliseconds.
+     * @param {number} milliseconds - The number of milliseconds.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromMilliseconds(milliseconds: number): TimeSpan;
+    /**
+     * Creates a TimeSpan from a specified number of seconds.
+     * @param {number} seconds - The number of seconds.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromSeconds(seconds: number): TimeSpan;
+    /**
+     * Creates a TimeSpan from a specified number of minutes.
+     * @param {number} minutes - The number of minutes.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromMinutes(minutes: number): TimeSpan;
+    /**
+     * Creates a TimeSpan from a specified number of hours.
+     * @param {number} hours - The number of hours.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromHours(hours: number): TimeSpan;
+    /**
+     * Creates a TimeSpan from a specified number of days.
+     * @param {number} days - The number of days.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromDays(days: number): TimeSpan;
+    /**
+     * Creates a TimeSpan from a specified number of weeks.
+     * @param {number} weeks - The number of weeks.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     static fromWeeks(weeks: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of milliseconds to this instance.
+     * @param {number} milliseconds - The milliseconds to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addMilliseconds(milliseconds: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of seconds to this instance.
+     * @param {number} seconds - The seconds to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addSeconds(seconds: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of minutes to this instance.
+     * @param {number} minutes - The minutes to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addMinutes(minutes: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of hours to this instance.
+     * @param {number} hours - The hours to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addHours(hours: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of days to this instance.
+     * @param {number} days - The days to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addDays(days: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified number of weeks to this instance.
+     * @param {number} weeks - The weeks to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     addWeeks(weeks: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of milliseconds from this instance.
+     * @param {number} milliseconds - The milliseconds to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractMilliseconds(milliseconds: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of seconds from this instance.
+     * @param {number} seconds - The seconds to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractSeconds(seconds: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of minutes from this instance.
+     * @param {number} minutes - The minutes to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractMinutes(minutes: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of hours from this instance.
+     * @param {number} hours - The hours to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractHours(hours: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of days from this instance.
+     * @param {number} days - The days to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractDays(days: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified number of weeks from this instance.
+     * @param {number} weeks - The weeks to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtractWeeks(weeks: number): TimeSpan;
+    /**
+     * Returns a new TimeSpan that adds the specified TimeSpan to this instance.
+     * @param {TimeSpan} other - The TimeSpan to add.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     add(other: TimeSpan): TimeSpan;
+    /**
+     * Returns a new TimeSpan that subtracts the specified TimeSpan from this instance.
+     * @param {TimeSpan} other - The TimeSpan to subtract.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     subtract(other: TimeSpan): TimeSpan;
+    /**
+     * Adds this TimeSpan to a specified Date.
+     * @param {Date} date - The date to add to.
+     * @returns {Date} A new Date instance.
+     */
     addTo(date: Date): Date;
+    /**
+     * Subtracts this TimeSpan from a specified Date.
+     * @param {Date} date - The date to subtract from.
+     * @returns {Date} A new Date instance.
+     */
     subtractFrom(date: Date): Date;
+    /**
+     * Creates a TimeSpan from the difference between two dates.
+     * @param {Date} earlierDate - The earlier date.
+     * @param {Date} laterDate - The later date.
+     * @returns {TimeSpan} A new TimeSpan instance representing the difference.
+     */
     static fromDifference(earlierDate: Date, laterDate: Date): TimeSpan;
+    /**
+     * Formats the TimeSpan as a string.
+     * Supported tokens: hh, h, mm, m, ss, s.
+     * @param {string} format - The format string (default: 'hh:mm:ss').
+     * @returns {string} The formatted string.
+     */
     format(format?: string): string;
+    /**
+     * Checks if this TimeSpan is equal to another.
+     * @param {TimeSpan} other - The other TimeSpan.
+     * @returns {boolean} True if equal.
+     */
     eq(other: TimeSpan): boolean;
+    /**
+     * Checks if this TimeSpan is less than or equal to another.
+     * @param {TimeSpan} other - The other TimeSpan.
+     * @returns {boolean} True if less than or equal.
+     */
     le(other: TimeSpan): boolean;
+    /**
+     * Checks if this TimeSpan is less than another.
+     * @param {TimeSpan} other - The other TimeSpan.
+     * @returns {boolean} True if less than.
+     */
     lt(other: TimeSpan): boolean;
+    /**
+     * Checks if this TimeSpan is greater than or equal to another.
+     * @param {TimeSpan} other - The other TimeSpan.
+     * @returns {boolean} True if greater than or equal.
+     */
     ge(other: TimeSpan): boolean;
+    /**
+     * Checks if this TimeSpan is greater than another.
+     * @param {TimeSpan} other - The other TimeSpan.
+     * @returns {boolean} True if greater than.
+     */
     gt(other: TimeSpan): boolean;
+    /**
+     * Multiplies the TimeSpan by a number.
+     * @param {number} number - The multiplier.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     multiply(number: number): TimeSpan;
+    /**
+     * Divides the TimeSpan by a number.
+     * @param {number} number - The divisor.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     divide(number: number): TimeSpan;
+    /**
+     * Returns the absolute value of the TimeSpan.
+     * @returns {TimeSpan} A new TimeSpan instance.
+     */
     abs(): TimeSpan;
+    /**
+     * Infinite duration.
+     */
     static readonly INFINITE: TimeSpan;
+    /**
+     * Negative infinite duration.
+     */
     static readonly NEGATIVE_INFINITE: TimeSpan;
+    /**
+     * Checks if the TimeSpan is infinite.
+     * @returns {boolean} True if infinite.
+     */
     isInfinite(): boolean;
+    /**
+     * Checks if the TimeSpan is positive infinite.
+     * @returns {boolean} True if positive infinite.
+     */
     isPositiveInfinite(): boolean;
+    /**
+     * Checks if the TimeSpan is negative infinite.
+     * @returns {boolean} True if negative infinite.
+     */
     isNegativeInfinite(): boolean;
 }
 //# sourceMappingURL=timespan.d.ts.map