fix(vectors): arg types limit(), add docs

thi-ng · Nov 1, 2021 · d9e8404 · d9e8404
1 parent 56dba9a
commit d9e8404
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/packages/vectors/src/limit.ts b/packages/vectors/src/limit.ts
@@ -1,9 +1,17 @@
-import type { ReadonlyVec, Vec } from "./api.js";
+import type { VecOpVN } from "./api.js";
 import { mag } from "./mag.js";
 import { mulN } from "./muln.js";
 import { set } from "./set.js";
 
-export const limit = (out: Vec, v: ReadonlyVec, n: number) => {
+/**
+ * Limits `v` to max length `n` and writes result to `out` (or to itself if
+ * `out` is null).
+ *
+ * @param out
+ * @param v
+ * @param n
+ */
+export const limit: VecOpVN = (out, v, n) => {
     !out && (out = v);
     const m = mag(v);
     return m > n ? mulN(out, v, n / m) : out !== v ? set(out, v) : out;