Finish documentation

src/helper/array.ts

@@ -1,3 +1,4 @@
+/** @internal */
 declare global {
   interface Array<T> {
     x: number;
@@ -10,6 +11,7 @@ declare global {
   }
 }
 
+/** @internal */
 const setIndexAlias = (name: string, index: number, type: any) => {
   if (!Object.prototype.hasOwnProperty.call(type.prototype, name)) {
     Object.defineProperty(type.prototype, name, {
@@ -23,6 +25,7 @@ const setIndexAlias = (name: string, index: number, type: any) => {
   }
 };
 
+/** @internal */
 export const applyArrayPlugins = () => {
   setIndexAlias('x', 0, Array);
   setIndexAlias('y', 1, Array);

src/helper/clamp.ts

@@ -1,4 +1,6 @@
+/** @internal */
 export const clamp = (value: number, min: number, max: number): number =>
   Math.min(max, Math.max(min, value));
 
+/** @internal */
 export const clamp01 = (value: number): number => Math.min(1, Math.max(0, value));

src/helper/exponential-decay.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export const exponentialDecay = (
   accumulator: number,
   nextValue: number,

src/helper/get-combinations.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export const getCombinations = (values: Array<Array<number>>): Array<Array<number>> => {
   if (!values.every((a) => a.length > 0)) {
     return [];

src/helper/last.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export function last<T>(a: Array<T>): T | null {
   return a.length > 0 ? a[a.length - 1] : null;
 }

src/helper/mix.ts

@@ -1 +1,2 @@
+/** @internal */
 export const mix = (from: number, to: number, q: number) => from + (to - from) * q;

src/helper/ms-to-string.ts

@@ -1 +1,2 @@
+/** @internal */
 export const msToString = (value: number) => `${value.toFixed(3)} ms`;

src/helper/wait.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export const wait = (ms: number): Promise<void> => {
   return new Promise<void>((resolve, _) => setTimeout(resolve, ms));
 };