Table of Contents

• Installation
• Usage
• Test
• Contact
• Contributing
• License

Install

NPM:

npm install @compactjs/shuffle

Usage

/**
 * returns a shuffled array
 */
function shuffle(array: any[]): any[];

As module:

import { shuffle } from '@compactjs/shuffle';

Example:

const array = [0, 1, 2, 3];
const shuffled = shuffle(array);

console.log(array); // => [0, 1, 2, 3]
console.log(shuffled); // => e.g. [3, 1, 2, 0]

Run tests

npm run test

Contact

👤 Timo Bechtel

• Website: https://timobechtel.com
• Twitter: @TimoBechtel
• GitHub: @TimoBechtel

🤝 Contributing

Contributions, issues and feature requests are welcome!

1. Check issues
2. Fork the Project
3. Create your Feature Branch (git checkout -b feat/AmazingFeature)
4. Test your changes npm run test
5. Commit your Changes (git commit -m 'feat: add amazingFeature')
6. Push to the Branch (git push origin feat/AmazingFeature)
7. Open a Pull Request

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Distributed under the MIT License.

This README was generated with ❤️ by readme-md-generator