@gesslar/toolkit 0.2.5 → 0.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/toolkit",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Get in, bitches, we're going toolkitting.",
   "main": "./src/index.js",
   "type": "module",

package/src/lib/Collection.js

@@ -522,4 +522,41 @@ export default class Collection {
       return acc
     }, {})
   }
+
+  static trimArray(arr, except=[]) {
+    Valid.type(arr, "Array")
+    Valid.type(except, "Array")
+
+    Collection.trimArrayLeft(arr, except)
+    Collection.trimArrayRight(arr, except)
+
+    return arr
+  }
+
+  static trimArrayRight(arr, except=[]) {
+    Valid.type(arr, "Array")
+    Valid.type(except, "Array")
+
+    arr.reverse()
+    Collection.trimArrayLeft(arr, except)
+    arr.reverse()
+
+    return arr
+  }
+
+  static trimArrayLeft(arr, except=[]) {
+    Valid.type(arr, "Array")
+    Valid.type(except, "Array")
+
+    while(arr.length > 0) {
+      const value = arr[0]
+
+      if(value || except.includes(value))
+        break
+
+      arr.shift()
+    }
+
+    return arr
+  }
 }

package/src/types/Collection.d.ts

@@ -237,4 +237,64 @@ export default class Collection {
    * ```
    */
   static flattenObjectArray(objects: Array<Record<string, unknown>>): Record<string, Array<unknown>>
+
+  /**
+   * Trims falsy values from both ends of an array.
+   *
+   * @param arr - The array to trim
+   * @param except - Array of values to exclude from trimming (default: [])
+   * @returns The trimmed array (modified in place)
+   *
+   * @throws {Sass} If arr or except is not an Array
+   *
+   * @example
+   * ```typescript
+   * import { Collection } from '@gesslar/toolkit'
+   *
+   * const arr = [null, 0, 1, 2, "", undefined]
+   * Collection.trimArray(arr)
+   * console.log(arr) // [1, 2]
+   * ```
+   */
+  static trimArray<T>(arr: Array<T>, except?: Array<T>): Array<T>
+
+  /**
+   * Trims falsy values from the right end of an array.
+   *
+   * @param arr - The array to trim
+   * @param except - Array of values to exclude from trimming (default: [])
+   * @returns The trimmed array (modified in place)
+   *
+   * @throws {Sass} If arr or except is not an Array
+   *
+   * @example
+   * ```typescript
+   * import { Collection } from '@gesslar/toolkit'
+   *
+   * const arr = [1, "", undefined]
+   * Collection.trimArrayRight(arr)
+   * console.log(arr) // [1]
+   * ```
+   */
+  static trimArrayRight<T>(arr: Array<T>, except?: Array<T>): Array<T>
+
+  /**
+   * Trims falsy values from the left end of an array.
+   *
+   * @param arr - The array to trim
+   * @param except - Array of values to exclude from trimming (default: [])
+   * @returns The trimmed array (modified in place)
+   *
+   * @throws {Sass} If arr or except is not an Array
+   *
+   * @example
+   * ```typescript
+   * import { Collection } from '@gesslar/toolkit'
+   *
+   * const arr = [null, undefined, "value"]
+   * Collection.trimArrayLeft(arr)
+   * console.log(arr) // ["value"]
+   * ```
+   */
+  static trimArrayLeft<T>(arr: Array<T>, except?: Array<T>): Array<T>
 }