Project Init

node_modules/es-toolkit/dist/array/shuffle.d.mts

@@ -0,0 +1,18 @@
+//#region src/array/shuffle.d.ts
+/**
+ * Randomizes the order of elements in an array using the Fisher-Yates algorithm.
+ *
+ * This function takes an array and returns a new array with its elements shuffled in a random order.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} arr - The array to shuffle.
+ * @returns {T[]} A new array with its elements shuffled in random order.
+ *
+ * @example
+ * const array = [1, 2, 3, 4, 5];
+ * const shuffledArray = shuffle(array);
+ * // shuffledArray will be a new array with elements of array in random order, e.g., [3, 1, 4, 5, 2]
+ */
+declare function shuffle<T>(arr: readonly T[]): T[];
+//#endregion
+export { shuffle };