@inglorious/utils 3.5.1 → 3.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/utils",
-  "version": "3.5.1",
+  "version": "3.5.3",
   "description": "A set of general-purpose utility functions designed with functional programming principles in mind.",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",

package/src/v.js

@@ -2,7 +2,7 @@
  * @typedef {import("../types/math").Vector} Vector
  */
 
-import { isArray } from "./data-structures/array"
+import { isArray } from "./data-structures/array.js"
 
 /**
  * Ensures that a given value is a vector.

package/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./algorithms"
 export * from "./data-structures"
 export * from "./math"
+export * from "./v"

package/types/v.d.ts

@@ -0,0 +1,25 @@
+import { Vector } from "./math"
+
+/**
+ * Ensures that a given value is a vector.
+ *
+ * If the value is an array of finite numbers but not already a vector (i.e., it lacks the `__isVector__` property),
+ * this function converts it into a vector by calling `v()`. If the value is already a vector or not a numeric array,
+ * it is returned unchanged. This is particularly useful for ensuring that the results of standard array operations
+ * (like `.map()` or `.filter()`) which return a new array are correctly re-tagged as vectors.
+ *
+ * @template T
+ * @param {T} value The value to check and potentially convert.
+ * @returns {T extends number[] ? Vector : T} The value as a vector, or the original value if no conversion was needed.
+ */
+export function ensureV<T>(value: T): T extends number[] ? Vector : T
+
+/**
+ * A utility function to create a vector from a list of coordinates.
+ * This is a shorthand for `[x, y, z, ...]`.
+ * It also tags the array with a non-enumerable `__isVector__` property for
+ * efficient type checking.
+ * @param {...number} coords - The coordinates of the vector.
+ * @returns {Vector} The created vector.
+ */
+export function v(...coords: number[]): Vector