shuffle-darkernel

shuffle-darkernel

A simple and efficient array shuffling utility package powered by Lodash

📦 Installation

Install the package using npm or pnpm:

npm install shuffle-darkernel

or

pnpm add shuffle-darkernel

🚀 Usage

The package provides a straightforward way to shuffle arrays using the reliable Lodash shuffle algorithm.

ES6 Modules

import shuffleArray from 'shuffle-darkernel';

const numbers = [1, 2, 3, 4, 5];
const shuffled = shuffleArray(numbers);

console.log(shuffled); // e.g., [3, 1, 5, 2, 4]

Named Import

import { shuffleArray } from 'shuffle-darkernel/utils.js';

const colors = ['red', 'blue', 'green', 'yellow'];
const shuffledColors = shuffleArray(colors);

console.log(shuffledColors); // Randomly shuffled array

🎯 Features

• ✨ Simple and intuitive API
• 🔒 Non-destructive - returns a new shuffled array
• ⚡ Fast and efficient using Lodash under the hood
• 📘 ES6 module support
• 🪶 Lightweight with minimal dependencies

📖 API Reference

shuffleArray(array)

Shuffles an array using the Fisher-Yates shuffle algorithm (via Lodash).

Parameters:

• array (Array): The array to shuffle

Returns:

• (Array): A new shuffled array

Example:

import shuffleArray from 'shuffle-darkernel';

const deck = ['A', 'K', 'Q', 'J', '10'];
const shuffledDeck = shuffleArray(deck);

console.log(deck);         // Original: ['A', 'K', 'Q', 'J', '10']
console.log(shuffledDeck); // Shuffled: ['Q', 'A', '10', 'J', 'K']

🔧 Development

Run locally

# Clone the repository
git clone https://github.com/cggithub333/shuffle-darkernel.git

# Navigate to the project directory
cd shuffle-darkernel

# Install dependencies
pnpm install

# Run the demo
pnpm run dev

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📝 License

This project is ISC licensed.

👤 Author

BrianHa

• GitHub: @cggithub333

🙏 Acknowledgments

• Built with Lodash
• Inspired by the need for simple, reliable array shuffling

Made with ❤️ by Darkernel