feat(array): move

src/array.ts

@@ -1,3 +1,4 @@
+import { clamp } from './math'
 import { Arrayable, Nullable } from './types'
 
 /**
@@ -125,3 +126,25 @@ export function range(...args: any): number[] {
 
   return arr
 }
+
+/**
+ * Move element in an Array
+ *
+ * @category Array
+ * @param arr
+ * @param from
+ * @param to
+ */
+export function move<T>(arr: T[], from: number, to: number) {
+  arr.splice(to, 0, arr.splice(from, 1)[0])
+  return arr
+}
+
+/**
+ * Clamp a number to the index ranage of an array
+ *
+ * @category Array
+ */
+export function clampArrayRange(n: number, arr: readonly unknown[]) {
+  return clamp(n, 0, arr.length - 1)
+}

src/guards.ts

@@ -1,6 +1,7 @@
 /**
  * Type guard to filter out null-ish values
  *
+ * @category Guards
  * @example array.filter(notNullish)
  */
 export function notNullish<T>(v: T | null | undefined): v is NonNullable<T> {
@@ -10,6 +11,7 @@ export function notNullish<T>(v: T | null | undefined): v is NonNullable<T> {
 /**
  * Type guard to filter out null values
  *
+ * @category Guards
  * @example array.filter(noNull)
  */
 export function noNull<T>(v: T | null): v is Exclude<T, null> {
@@ -19,6 +21,7 @@ export function noNull<T>(v: T | null): v is Exclude<T, null> {
 /**
  * Type guard to filter out null-ish values
  *
+ * @category Guards
  * @example array.filter(notUndefined)
  */
 export function notUndefined<T>(v: T): v is Exclude<T, undefined> {
@@ -28,6 +31,7 @@ export function notUndefined<T>(v: T): v is Exclude<T, undefined> {
 /**
  * Type guard to filter out falsy values
  *
+ * @category Guards
  * @example array.filter(isTruthy)
  */
 export function isTruthy<T>(v: T): v is NonNullable<T> {