https://github.com/compactjs/shuffle
Shuffle arrays without sideeffects
https://github.com/compactjs/shuffle
array javascript no-side-effects shuffle
Last synced: 3 months ago
JSON representation
Shuffle arrays without sideeffects
- Host: GitHub
- URL: https://github.com/compactjs/shuffle
- Owner: CompactJS
- License: mit
- Created: 2020-05-06T18:44:41.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-10T00:50:06.000Z (almost 3 years ago)
- Last Synced: 2025-02-15T21:21:44.798Z (3 months ago)
- Topics: array, javascript, no-side-effects, shuffle
- Language: JavaScript
- Homepage:
- Size: 763 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
🃏
@compactjs/shuffle
Shuffle arrays
·
Homepage
·
Report Bug / Request Feature
·
## Table of Contents
- [Installation](#Install)
- [Usage](#usage)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## Install
### NPM:
```sh
npm install @compactjs/shuffle
```
## Usage
```typescript
/**
* returns a shuffled array
*/
function shuffle(array: any[]): any[];
```
### As module:
```javascript
import { shuffle } from '@compactjs/shuffle';
```
### Example:
```javascript
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
```sh
npm run test
```
## Contact
👤 **Timo Bechtel**
- Website: https://timobechtel.com
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/CompactJS/shuffle/issues)
1. Fork the Project
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `npm run test`
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the Branch (`git push origin feat/AmazingFeature`)
1. Open a Pull Request
### Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Distributed under the [MIT](https://github.com/CompactJS/shuffle/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_