tiny-essentials 1.25.1 → 1.25.2

package/changelog/1/25/2.md

@@ -0,0 +1,9 @@
+## Release Notes 🚀
+
+### Fixed
+- Fixed jsDoc issues in `multiplyArrayBlocks` function. 🛠️
+- Fixed jsDoc issues in `shuffleArray` function. 🛠️
+
+*Improved documentation for better code clarity!* ✨
+
+**Full Changelog**: https://github.com/JasminDreasond/Tiny-Essentials/compare/1.25.1...1.25.2

package/dist/v1/basics/array.cjs

@@ -8,8 +8,9 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {any[]} items - The array to shuffle.
- * @returns {any[]} The same array instance, now shuffled in place.
+ * @template {any[]} T
+ * @param {T} items - The array to shuffle.
+ * @returns {T} The same array instance, now shuffled in place.
  */
 function shuffleArray(items) {
   let currentIndex = items.length,
@@ -31,9 +32,9 @@ function shuffleArray(items) {
 /**
  * Generates an array with repeated phases according to counts.
  *
- * @param {string[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
+ * @param {any[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
  * @param {number[]} counts - Array of integers specifying how many times to repeat each phase, e.g., [4,5,5,4].
- * @returns {string[]} - Flattened array containing phases repeated according to counts, concatenated in order.
+ * @returns {any[]} - Flattened array containing phases repeated according to counts, concatenated in order.
  */
 function multiplyArrayBlocks(phases, counts) {
   // phases: array de strings, cada fase (ex: ['Full', 'Half1', 'Half2', 'New'])

package/dist/v1/basics/array.d.mts

@@ -4,18 +4,19 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {any[]} items - The array to shuffle.
- * @returns {any[]} The same array instance, now shuffled in place.
+ * @template {any[]} T
+ * @param {T} items - The array to shuffle.
+ * @returns {T} The same array instance, now shuffled in place.
  */
-export function shuffleArray(items: any[]): any[];
+export function shuffleArray<T extends any[]>(items: T): T;
 /**
  * Generates an array with repeated phases according to counts.
  *
- * @param {string[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
+ * @param {any[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
  * @param {number[]} counts - Array of integers specifying how many times to repeat each phase, e.g., [4,5,5,4].
- * @returns {string[]} - Flattened array containing phases repeated according to counts, concatenated in order.
+ * @returns {any[]} - Flattened array containing phases repeated according to counts, concatenated in order.
  */
-export function multiplyArrayBlocks(phases: string[], counts: number[]): string[];
+export function multiplyArrayBlocks(phases: any[], counts: number[]): any[];
 /**
  * Diff two class lists.
  * @param {any[]} oldItems

package/dist/v1/basics/array.mjs

@@ -5,8 +5,9 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {any[]} items - The array to shuffle.
- * @returns {any[]} The same array instance, now shuffled in place.
+ * @template {any[]} T
+ * @param {T} items - The array to shuffle.
+ * @returns {T} The same array instance, now shuffled in place.
  */
 export function shuffleArray(items) {
     let currentIndex = items.length, randomIndex;
@@ -23,9 +24,9 @@ export function shuffleArray(items) {
 /**
  * Generates an array with repeated phases according to counts.
  *
- * @param {string[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
+ * @param {any[]} phases - Array of phase names, e.g., ['Full', 'Half1', 'Half2', 'New'].
  * @param {number[]} counts - Array of integers specifying how many times to repeat each phase, e.g., [4,5,5,4].
- * @returns {string[]} - Flattened array containing phases repeated according to counts, concatenated in order.
+ * @returns {any[]} - Flattened array containing phases repeated according to counts, concatenated in order.
  */
 export function multiplyArrayBlocks(phases, counts) {
     // phases: array de strings, cada fase (ex: ['Full', 'Half1', 'Half2', 'New'])

package/docs/v1/basics/array.md

@@ -4,11 +4,11 @@ A minimal and handy module offering a couple of focused utilities for working wi
 
 ---
 
-## `shuffleArray(items: string[]): string[]`
+## `shuffleArray(items: any[]): any[]`
 
 🔄 A tiny utility for shuffling arrays using the good old Fisher–Yates algorithm. Simple, efficient, and perfectly random (as far as JavaScript's `Math.random()` allows, anyway).
 
-- **items** — An array of strings to shuffle.
+- **items** — An array to shuffle.
 - **Returns** — The same array instance, but now shuffled.
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.25.1",
+  "version": "1.25.2",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",