@ix-xs/node-comfort 1.1.31 → 1.2.0

package/types/src/Num.d.ts

@@ -0,0 +1,242 @@
+/**
+ * Clamps a number between a minimum and maximum.
+ *
+ * @example
+ * nodeComfort.num.clamp(15, 0, 10); // 10
+ * nodeComfort.num.clamp(-3, 0, 10); // 0
+ *
+ * @param {number} value - Value to clamp.
+ * @param {number} min - Lower bound.
+ * @param {number} max - Upper bound.
+ * @returns {number} The clamped value.
+ */
+export function clamp(value: number, min: number, max: number): number;
+/**
+ * Checks whether a number is within an inclusive `[min, max]` range.
+ *
+ * @param {number} value - Value to test.
+ * @param {number} min - Lower bound.
+ * @param {number} max - Upper bound.
+ * @returns {boolean} True if within range.
+ */
+export function inRange(value: number, min: number, max: number): boolean;
+/**
+ * Rounds a number to a given number of decimal places (avoids float artifacts).
+ *
+ * @example
+ * nodeComfort.num.round(1.005, 2); // 1.01
+ *
+ * @param {number} value - Value to round.
+ * @param {number} [decimals=0] - Number of decimal places.
+ * @returns {number} The rounded number.
+ */
+export function round(value: number, decimals?: number): number;
+/**
+ * Rounds a number down to a given number of decimal places.
+ *
+ * @param {number} value - Value to round.
+ * @param {number} [decimals=0] - Number of decimal places.
+ * @returns {number} The floored number.
+ */
+export function floor(value: number, decimals?: number): number;
+/**
+ * Rounds a number up to a given number of decimal places.
+ *
+ * @param {number} value - Value to round.
+ * @param {number} [decimals=0] - Number of decimal places.
+ * @returns {number} The ceiled number.
+ */
+export function ceil(value: number, decimals?: number): number;
+/**
+ * Linearly interpolates between `start` and `end` by ratio `t` (0..1).
+ *
+ * @example
+ * nodeComfort.num.lerp(0, 100, 0.5); // 50
+ *
+ * @param {number} start - Start value.
+ * @param {number} end - End value.
+ * @param {number} t - Interpolation factor (usually 0..1).
+ * @returns {number} The interpolated value.
+ */
+export function lerp(start: number, end: number, t: number): number;
+/**
+ * Re-maps a number from one range to another.
+ *
+ * @example
+ * nodeComfort.num.mapRange(5, 0, 10, 0, 100); // 50
+ *
+ * @param {number} value - Value to map.
+ * @param {number} inMin - Input range minimum.
+ * @param {number} inMax - Input range maximum.
+ * @param {number} outMin - Output range minimum.
+ * @param {number} outMax - Output range maximum.
+ * @returns {number} The mapped value.
+ */
+export function mapRange(value: number, inMin: number, inMax: number, outMin: number, outMax: number): number;
+/**
+ * Returns a random number (float) in `[min, max)`.
+ *
+ * Not cryptographically secure. For secure randomness use `nodeComfort.id`.
+ *
+ * @param {number} [min=0] - Lower bound (inclusive).
+ * @param {number} [max=1] - Upper bound (exclusive).
+ * @returns {number} A random float.
+ */
+export function random(min?: number, max?: number): number;
+/**
+ * Returns a random integer in `[min, max]` (both inclusive).
+ *
+ * @example
+ * nodeComfort.num.randomInt(1, 6); // dice roll
+ *
+ * @param {number} min - Lower bound (inclusive).
+ * @param {number} max - Upper bound (inclusive).
+ * @returns {number} A random integer.
+ */
+export function randomInt(min: number, max: number): number;
+/**
+ * Sums all numbers in an array.
+ *
+ * @param {number[]} values - Array of numbers.
+ * @returns {number} The sum (0 for an empty array).
+ */
+export function sum(values: number[]): number;
+/**
+ * Returns the arithmetic mean (average) of an array of numbers.
+ *
+ * @param {number[]} values - Array of numbers.
+ * @returns {number} The average (0 for an empty array).
+ */
+export function average(values: number[]): number;
+/**
+ * Returns the median value of an array of numbers.
+ *
+ * @param {number[]} values - Array of numbers.
+ * @returns {number} The median (0 for an empty array).
+ */
+export function median(values: number[]): number;
+/**
+ * Returns the smallest number in an array.
+ *
+ * @param {number[]} values - Array of numbers.
+ * @returns {number|undefined} The minimum, or undefined if empty.
+ */
+export function min(values: number[]): number | undefined;
+/**
+ * Returns the largest number in an array.
+ *
+ * @param {number[]} values - Array of numbers.
+ * @returns {number|undefined} The maximum, or undefined if empty.
+ */
+export function max(values: number[]): number | undefined;
+/**
+ * Computes what percentage `value` is of `total`.
+ *
+ * @example
+ * nodeComfort.num.percent(25, 200); // 12.5
+ *
+ * @param {number} value - Partial value.
+ * @param {number} total - Total value.
+ * @param {number} [decimals=2] - Decimal places to keep.
+ * @returns {number} The percentage.
+ */
+export function percent(value: number, total: number, decimals?: number): number;
+/**
+ * Formats a byte count into a human-readable string (KB, MB, GB, ...).
+ *
+ * By default uses binary sizing (base 1024) with familiar `KB`/`MB` labels.
+ * Set `binary: false` for SI sizing (base 1000), or `iec: true` for
+ * strict `KiB`/`MiB` labels.
+ *
+ * @example
+ * nodeComfort.num.formatBytes(1536);                 // "1.5 KB"
+ * nodeComfort.num.formatBytes(1073741824);           // "1 GB"
+ * nodeComfort.num.formatBytes(1000, { binary: false }); // "1 KB"
+ * nodeComfort.num.formatBytes(1024, { iec: true });     // "1 KiB"
+ *
+ * @param {number} bytes - Number of bytes.
+ * @param {{ decimals?: number, binary?: boolean, iec?: boolean }} [options] - Formatting options.
+ * @returns {string} The human-readable size.
+ */
+export function formatBytes(bytes: number, options?: {
+    decimals?: number;
+    binary?: boolean;
+    iec?: boolean;
+}): string;
+/**
+ * Formats a large number with a compact suffix (K, M, B, T).
+ *
+ * @example
+ * nodeComfort.num.abbreviate(1500);      // "1.5K"
+ * nodeComfort.num.abbreviate(2_400_000); // "2.4M"
+ *
+ * @param {number} value - Number to abbreviate.
+ * @param {number} [decimals=1] - Decimal places.
+ * @returns {string} The abbreviated number.
+ */
+export function abbreviate(value: number, decimals?: number): string;
+/**
+ * Inserts thousands separators into a number.
+ *
+ * @example
+ * nodeComfort.num.thousands(1234567);        // "1,234,567"
+ * nodeComfort.num.thousands(1234.5, " ");    // "1 234.5"
+ *
+ * @param {number} value - Number to format.
+ * @param {string} [separator=","] - Thousands separator.
+ * @returns {string} The formatted number.
+ */
+export function thousands(value: number, separator?: string): string;
+/**
+ * Returns the English ordinal suffix for a number ("st", "nd", "rd", "th").
+ *
+ * @example
+ * nodeComfort.num.ordinal(1);  // "1st"
+ * nodeComfort.num.ordinal(22); // "22nd"
+ *
+ * @param {number} value - The number.
+ * @returns {string} The number with its ordinal suffix.
+ */
+export function ordinal(value: number): string;
+/**
+ * Parses a value into a number, returning a fallback when it isn't numeric.
+ *
+ * @example
+ * nodeComfort.num.parse("42px");        // 42
+ * nodeComfort.num.parse("nope", 0);     // 0
+ *
+ * @param {*} value - Value to parse.
+ * @param {number} [fallback=NaN] - Value returned when parsing fails.
+ * @returns {number} The parsed number or the fallback.
+ */
+export function parse(value: any, fallback?: number): number;
+/**
+ * Checks whether a number is even.
+ * @param {number} value - Number to check.
+ * @returns {boolean} True if even.
+ */
+export function isEven(value: number): boolean;
+/**
+ * Checks whether a number is odd.
+ * @param {number} value - Number to check.
+ * @returns {boolean} True if odd.
+ */
+export function isOdd(value: number): boolean;
+/**
+ * Returns an array of numbers from `start` to `end`.
+ *
+ * `end` is exclusive. Supports a custom step and descending ranges.
+ *
+ * @example
+ * nodeComfort.num.range(4);          // [0, 1, 2, 3]
+ * nodeComfort.num.range(1, 5);       // [1, 2, 3, 4]
+ * nodeComfort.num.range(0, 10, 2);   // [0, 2, 4, 6, 8]
+ * nodeComfort.num.range(5, 0);       // [5, 4, 3, 2, 1]
+ *
+ * @param {number} start - Start (or end if it's the only argument).
+ * @param {number} [end] - End (exclusive).
+ * @param {number} [step] - Step size (defaults to 1 or -1 based on direction).
+ * @returns {number[]} The generated range.
+ */
+export function range(start: number, end?: number, step?: number): number[];
+//# sourceMappingURL=Num.d.ts.map

package/types/src/Num.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Num.d.ts","sourceRoot":"","sources":["../../src/Num.js"],"names":[],"mappings":"AAOE;;;;;;;;;;;GAWG;AACH,6BALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;GAOG;AACH,+BALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,6BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;GAMG;AACH,6BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;GAMG;AACH,4BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,4BALW,MAAM,OACN,MAAM,KACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;;;GAYG;AACH,gCAPW,MAAM,SACN,MAAM,SACN,MAAM,UACN,MAAM,UACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;GAQG;AACH,6BAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;GASG;AACH,+BAJW,MAAM,OACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;GAKG;AACH,4BAHW,MAAM,EAAE,GACN,MAAM,CAIlB;AAED;;;;;GAKG;AACH,gCAHW,MAAM,EAAE,GACN,MAAM,CAIlB;AAED;;;;;GAKG;AACH,+BAHW,MAAM,EAAE,GACN,MAAM,CAOlB;AAED;;;;;GAKG;AACH,4BAHW,MAAM,EAAE,GACN,MAAM,GAAC,SAAS,CAI5B;AAED;;;;;GAKG;AACH,4BAHW,MAAM,EAAE,GACN,MAAM,GAAC,SAAS,CAI5B;AAED;;;;;;;;;;GAUG;AACH,+BALW,MAAM,SACN,MAAM,aACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,mCAJW,MAAM,YACN;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,GACpD,MAAM,CAalB;AAED;;;;;;;;;;GAUG;AACH,kCAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAelB;AAED;;;;;;;;;;GAUG;AACH,iCAJW,MAAM,cACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;;GASG;AACH,+BAHW,MAAM,GACJ,MAAM,CASlB;AAED;;;;;;;;;;GAUG;AACH,6BAJW,GAAC,aACD,MAAM,GACJ,MAAM,CAMlB;AAED;;;;GAIG;AACH,8BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;GAIG;AACH,6BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;;;;;;;;GAeG;AACH,6BALW,MAAM,QACN,MAAM,SACN,MAAM,GACJ,MAAM,EAAE,CAkBpB"}

package/types/src/Obj.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Deeply clones a value.
+ *
+ * Uses the native `structuredClone` when the value supports it (plain data,
+ * Dates, Maps, Sets, typed arrays, ...), and falls back to a manual deep copy
+ * otherwise. Functions are copied by reference.
+ *
+ * @example
+ * const copy = nodeComfort.obj.clone({ a: { b: 1 } });
+ *
+ * @template T
+ * @param {T} value - Value to clone.
+ * @returns {T} A deep copy.
+ */
+export function clone<T>(value: T): T;
+/**
+ * Deeply merges two or more plain objects into a new object.
+ *
+ * Later sources win. Plain-object values are merged recursively; arrays and
+ * other values are replaced (not concatenated). Inputs are never mutated.
+ *
+ * @example
+ * nodeComfort.obj.merge({ a: { x: 1 } }, { a: { y: 2 } });
+ * // { a: { x: 1, y: 2 } }
+ *
+ * @param {...Record<string, any>} sources - Objects to merge.
+ * @returns {Record<string, any>} The merged object.
+ */
+export function merge(...sources: Record<string, any>[]): Record<string, any>;
+/**
+ * Deeply compares two values for structural equality.
+ *
+ * Handles plain objects, arrays, Dates, RegExps, Maps and Sets.
+ *
+ * @example
+ * nodeComfort.obj.equal({ a: [1, 2] }, { a: [1, 2] }); // true
+ *
+ * @param {*} a - First value.
+ * @param {*} b - Second value.
+ * @returns {boolean} True if the values are deeply equal.
+ */
+export function equal(a: any, b: any): boolean;
+/**
+ * Gets a nested value from an object using a dot/bracket path.
+ *
+ * @example
+ * nodeComfort.obj.get({ a: { b: [{ c: 42 }] } }, "a.b[0].c");    // 42
+ * nodeComfort.obj.get({}, "a.b.c", "default");                   // "default"
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string|Array<string|number>} path - Dot path or key array.
+ * @param {*} [fallback] - Returned when the path does not resolve.
+ * @returns {*} The value at the path, or the fallback.
+ */
+export function get(object: Record<string, any>, path: string | Array<string | number>, fallback?: any): any;
+/**
+ * Sets a nested value in an object using a dot/bracket path (returns a clone).
+ *
+ * Intermediate objects/arrays are created as needed. The original object is
+ * not mutated.
+ *
+ * @example
+ * nodeComfort.obj.set({}, "a.b.c", 1); // { a: { b: { c: 1 } } }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string|Array<string|number>} path - Dot path or key array.
+ * @param {*} value - Value to set.
+ * @returns {Record<string, any>} A new object with the value set.
+ */
+export function set(object: Record<string, any>, path: string | Array<string | number>, value: any): Record<string, any>;
+/**
+ * Checks whether a nested path exists in an object.
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string|Array<string|number>} path - Dot path or key array.
+ * @returns {boolean} True if the path resolves.
+ */
+export function has(object: Record<string, any>, path: string | Array<string | number>): boolean;
+/**
+ * Returns a new object containing only the given keys.
+ *
+ * @example
+ * nodeComfort.obj.pick({ a: 1, b: 2, c: 3 }, ["a", "c"]); // { a: 1, c: 3 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string[]} keys - Keys to keep.
+ * @returns {Record<string, any>} The picked object.
+ */
+export function pick(object: Record<string, any>, keys: string[]): Record<string, any>;
+/**
+ * Returns a new object without the given keys.
+ *
+ * @example
+ * nodeComfort.obj.omit({ a: 1, b: 2, c: 3 }, ["b"]); // { a: 1, c: 3 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string[]} keys - Keys to remove.
+ * @returns {Record<string, any>} The remaining object.
+ */
+export function omit(object: Record<string, any>, keys: string[]): Record<string, any>;
+/**
+ * Returns a new object keeping only the entries that pass a predicate.
+ *
+ * @example
+ * nodeComfort.obj.filter({ a: 1, b: 2, c: 3 }, (v) => v > 1); // { b: 2, c: 3 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {(value: any, key: string) => boolean} predicate - Test function.
+ * @returns {Record<string, any>} The filtered object.
+ */
+export function filter(object: Record<string, any>, predicate: (value: any, key: string) => boolean): Record<string, any>;
+/**
+ * Maps over an object's values, returning a new object with the same keys.
+ *
+ * @example
+ * nodeComfort.obj.mapValues({ a: 1, b: 2 }, (v) => v * 10); // { a: 10, b: 20 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {(value: any, key: string) => any} fn - Mapping function.
+ * @returns {Record<string, any>} The mapped object.
+ */
+export function mapValues(object: Record<string, any>, fn: (value: any, key: string) => any): Record<string, any>;
+/**
+ * Maps over an object's keys, returning a new object with remapped keys.
+ *
+ * @example
+ * nodeComfort.obj.mapKeys({ a: 1 }, (k) => k.toUpperCase()); // { A: 1 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {(key: string, value: any) => string} fn - Key-mapping function.
+ * @returns {Record<string, any>} The remapped object.
+ */
+export function mapKeys(object: Record<string, any>, fn: (key: string, value: any) => string): Record<string, any>;
+/**
+ * Swaps keys and values of an object.
+ *
+ * @example
+ * nodeComfort.obj.invert({ a: "x", b: "y" }); // { x: "a", y: "b" }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @returns {Record<string, string>} The inverted object.
+ */
+export function invert(object: Record<string, any>): Record<string, string>;
+/**
+ * Removes entries whose value is `null` or `undefined` (shallow).
+ *
+ * @example
+ * nodeComfort.obj.compact({ a: 1, b: null, c: undefined }); // { a: 1 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @returns {Record<string, any>} The compacted object.
+ */
+export function compact(object: Record<string, any>): Record<string, any>;
+/**
+ * Flattens a nested object into a single-level object with dot-path keys.
+ *
+ * @example
+ * nodeComfort.obj.flatten({ a: { b: { c: 1 } } }); // { "a.b.c": 1 }
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @param {string} [prefix=""] - Prefix for keys (used internally).
+ * @returns {Record<string, any>} The flattened object.
+ */
+export function flatten(object: Record<string, any>, prefix?: string): Record<string, any>;
+/**
+ * Rebuilds a nested object from a flat, dot-path keyed object.
+ *
+ * @example
+ * nodeComfort.obj.unflatten({ "a.b.c": 1 }); // { a: { b: { c: 1 } } }
+ *
+ * @param {Record<string, any>} object - Flat object.
+ * @returns {Record<string, any>} The nested object.
+ */
+export function unflatten(object: Record<string, any>): Record<string, any>;
+/**
+ * Checks whether an object has no own enumerable keys.
+ *
+ * @param {Record<string, any>} object - Source object.
+ * @returns {boolean} True if the object is empty.
+ */
+export function isEmpty(object: Record<string, any>): boolean;
+/**
+ * Freezes an object deeply, making it (and all nested objects) immutable.
+ *
+ * @param {Record<string, any>} object - Object to freeze.
+ * @returns {Record<string, any>} The same, now deeply-frozen, object.
+ */
+export function deepFreeze(object: Record<string, any>): Record<string, any>;
+//# sourceMappingURL=Obj.d.ts.map

package/types/src/Obj.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Obj.d.ts","sourceRoot":"","sources":["../../src/Obj.js"],"names":[],"mappings":"AAmEE;;;;;;;;;;;;;GAaG;AACH,sBAJa,CAAC,SACH,CAAC,GACC,CAAC,CASb;AAED;;;;;;;;;;;;GAYG;AACH,kCAHc,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAA,GACpB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAkB/B;AAED;;;;;;;;;;;GAWG;AACH,yBAJW,GAAC,KACD,GAAC,GACC,OAAO,CA+BnB;AAED;;;;;;;;;;;GAWG;AACH,4BALW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QACnB,MAAM,GAAC,KAAK,CAAC,MAAM,GAAC,MAAM,CAAC,aAC3B,GAAC,GACC,GAAC,CAUb;AAED;;;;;;;;;;;;;GAaG;AACH,4BALW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QACnB,MAAM,GAAC,KAAK,CAAC,MAAM,GAAC,MAAM,CAAC,SAC3B,GAAC,GACC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgB/B;AAED;;;;;;GAMG;AACH,4BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QACnB,MAAM,GAAC,KAAK,CAAC,MAAM,GAAC,MAAM,CAAC,GACzB,OAAO,CAUnB;AAED;;;;;;;;;GASG;AACH,6BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QACnB,MAAM,EAAE,GACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAQ/B;AAED;;;;;;;;;GASG;AACH,6BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QACnB,MAAM,EAAE,GACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAS/B;AAED;;;;;;;;;GASG;AACH,+BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aACnB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,GAClC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAQ/B;AAED;;;;;;;;;GASG;AACH,kCAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MACnB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,KAAK,GAAG,GAC9B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAQ/B;AAED;;;;;;;;;GASG;AACH,gCAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MACnB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,MAAM,GACjC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAQ/B;AAED;;;;;;;;GAQG;AACH,+BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQlC;AAED;;;;;;;;GAQG;AACH,gCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAI/B;AAED;;;;;;;;;GASG;AACH,gCAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,WACnB,MAAM,GACJ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAa/B;AAED;;;;;;;;GAQG;AACH,kCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAQ/B;AAED;;;;;GAKG;AACH,gCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAInB;AAED;;;;;GAKG;AACH,mCAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAW/B"}

package/types/src/SQLite.d.ts

@@ -6,13 +6,18 @@ declare class SQLite {
      * The database file and its parent folders are created if necessary.
      * WAL journal mode and foreign key support are enabled automatically.
      *
-     * @param {string} [path] - Path to the SQLite database file.
+     * Pass `":memory:"` to create a transient in-memory database.
+     *
+     * @param {string} [path="db.sqlite"] - Path to the SQLite database file.
      *
      * @example
      * const db = new SQLite();
      *
      * @example
      * const db = new SQLite("data/my-app.sqlite");
+     *
+     * @example
+     * const db = new SQLite(":memory:");
      */
     constructor(path?: string);
     /**

package/types/src/SQLite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SQLite.d.ts","sourceRoot":"","sources":["../../src/SQLite.js"],"names":[],"mappings":";AA0DiB;IAef;;;;;;;;;;;;;OAaG;IACH,mBARW,MAAM,EAmBhB;IA8TD;;;;;;;;;;;;;;OAcG;IACH,UAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAQ5F;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC,MAAM,GAAC,SAAS,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAUvD;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC,MAAM,EAAE,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAS/C;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,mBAnDW;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YACvB,IAAI,EAAE,SAAS,GAAC,MAAM,GAAC,MAAM,GAAC,MAAM,GAAC,SAAS,CAAC;YAC/C,UAAU,CAAC,EAAE,OAAO,CAAC;YACrB,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;YACf,UAAU,CAAC,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;YAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC9B,WAAW,CAAC,EAAE,KAAK,CACf;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,GACrC;YAAE,IAAI,EAAE,YAAY,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,GACzC;YAAE,IAAI,EAAE,OAAO,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,GACrC;YACE,IAAI,EAAE,YAAY,CAAC;YACnB,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB,UAAU,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,OAAO,EAAE,MAAM,EAAE,CAAA;aAAE,CAAC;YACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CACJ,CAAC;QACF,OAAO,CAAC,EAAE,KAAK,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAC,CAAA;KACH,GACS,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAqCrD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAdW,MAAM,SACN;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,GACS,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCrD;IAED;;;;;OAKG;IACH,uBAHW,MAAM,GACJ,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAgBrD;IAED;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAerD;IAED;;;;;;OAMG;IACH,eAJW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC,MAAM,GAAC,SAAS,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiBvD;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,kBAlBW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACnB;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,KAAK,GAAC,MAAM,CAAA;KACzB,GACS,OAAO,CAAC,MAAM,EAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCjD;IAED;;;;;;;;;OASG;IACH,kBAJW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAwBtG;IAED;;;;;;;;;OASG;IACH,kBALW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SACnB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CA6BtE;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAZW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aACnB,MAAM,EAAE,GACN,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CA2CtG;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,eALW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UACnB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAC,IAAI,GACtB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCrD;IAED;;;;;;OAMG;IACH,kBAJW,MAAM,SACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAsBtE;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAmB/C;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAXa,CAAC,YACH,MAAM,CAAC,GAAC,OAAO,CAAC,CAAC,CAAC,GAChB,OAAO,CAAC,CAAC,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAwB1C;IAED;;;;;OAKG;IACH,cAIC;;CACF"}
+{"version":3,"file":"SQLite.d.ts","sourceRoot":"","sources":["../../src/SQLite.js"],"names":[],"mappings":";AA2DiB;IAef;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAXW,MAAM,EA2BhB;IA8TD;;;;;;;;;;;;;;OAcG;IACH,UAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAQ5F;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC,MAAM,GAAC,SAAS,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAUvD;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,GAAG,EAAE,GAAC,GAAG,GACP,OAAO,CAAC,MAAM,EAAE,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAS/C;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,mBAnDW;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YACvB,IAAI,EAAE,SAAS,GAAC,MAAM,GAAC,MAAM,GAAC,MAAM,GAAC,SAAS,CAAC;YAC/C,UAAU,CAAC,EAAE,OAAO,CAAC;YACrB,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;YACf,UAAU,CAAC,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;YAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC9B,WAAW,CAAC,EAAE,KAAK,CACf;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,GACrC;YAAE,IAAI,EAAE,YAAY,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,GACzC;YAAE,IAAI,EAAE,OAAO,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,GACrC;YACE,IAAI,EAAE,YAAY,CAAC;YACnB,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB,UAAU,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,OAAO,EAAE,MAAM,EAAE,CAAA;aAAE,CAAC;YACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CACJ,CAAC;QACF,OAAO,CAAC,EAAE,KAAK,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAC,CAAA;KACH,GACS,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAqCrD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAdW,MAAM,SACN;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,GACS,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCrD;IAED;;;;;OAKG;IACH,uBAHW,MAAM,GACJ,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAgBrD;IAED;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAerD;IAED;;;;;;OAMG;IACH,eAJW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC,MAAM,GAAC,SAAS,GAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiBvD;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,kBAlBW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACnB;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,KAAK,GAAC,MAAM,CAAA;KACzB,GACS,OAAO,CAAC,MAAM,EAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCjD;IAED;;;;;;;;;OASG;IACH,kBAJW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAwBtG;IAED;;;;;;;;;OASG;IACH,kBALW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SACnB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CA6BtE;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAZW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aACnB,MAAM,EAAE,GACN,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,GAAC,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CA2CtG;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,eALW,MAAM,QACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UACnB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAC,IAAI,GACtB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAiCrD;IAED;;;;;;OAMG;IACH,kBAJW,MAAM,SACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAsBtE;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,CAAC,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAmB/C;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAXa,CAAC,YACH,MAAM,CAAC,GAAC,OAAO,CAAC,CAAC,CAAC,GAChB,OAAO,CAAC,CAAC,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAwB1C;IAED;;;;;OAKG;IACH,cAIC;;CACF"}