open-index/open-npm huggingface dataset:
npm package: @compactjs/shuffle
Description: Shuffle arrays
Author: Timo Bechtel
Latest version: 1.0.1

<h1 align="center">🃏<br/>@compactjs/shuffle</h1>
<h3 align="center">Shuffle arrays</h3>
<p align="center">
  <a href="https://www.npmjs.com/package/@compactjs/shuffle" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/@compactjs/shuffle.svg">
  </a>
  <a href="https://github.com/CompactJS/shuffle/blob/main/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/compactjs/shuffle" />
  </a>
</p>
<p align="center">
  ·
  <a href="https://github.com/CompactJS/shuffle#readme">Homepage</a>
  ·
  <a href="https://github.com/CompactJS/shuffle/issues">Report Bug / Request Feature</a>
  ·
</p>

## 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!<br />

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)_
npm package: @compai/font-bai-jamjuree
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/bai-jamjuree)
Latest version: 0.0.3

# `@compai/font-bai-jamjuree`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/bai-jamjuree)
npm package: @compai/font-ibm-plex-sans-devanagari
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/ibm-plex-sans-devanagari)
Latest version: 0.0.1

# `@compai/font-ibm-plex-sans-devanagari`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/ibm-plex-sans-devanagari)
npm package: @compai/font-im-fell-dw-pica-sc
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/im-fell-dw-pica-sc)
Latest version: 0.0.3

# `@compai/font-im-fell-dw-pica-sc`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/im-fell-dw-pica-sc)
npm package: @compai/font-libre-barcode-39-text
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/libre-barcode-39-text)
Latest version: 0.0.3

# `@compai/font-libre-barcode-39-text`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/libre-barcode-39-text)
npm package: @compai/font-liu-jian-mao-cao
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/liu-jian-mao-cao)
Latest version: 0.0.3

# `@compai/font-liu-jian-mao-cao`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/liu-jian-mao-cao)
npm package: @compai/font-noto-sans-gothic
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-gothic)
Latest version: 0.0.1

# `@compai/font-noto-sans-gothic`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-gothic)
npm package: @compai/font-noto-sans-gunjala-gondi
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-gunjala-gondi)
Latest version: 0.0.1

# `@compai/font-noto-sans-gunjala-gondi`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-gunjala-gondi)
npm package: @compai/font-noto-sans-hanunoo
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-hanunoo)
Latest version: 0.0.1

# `@compai/font-noto-sans-hanunoo`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-hanunoo)
npm package: @compai/font-noto-sans-math
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-math)
Latest version: 0.0.1

# `@compai/font-noto-sans-math`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-math)
npm package: @compai/font-noto-sans-ogham
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-ogham)
Latest version: 0.0.1

# `@compai/font-noto-sans-ogham`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-ogham)
npm package: @compai/font-noto-sans-tagbanwa
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-tagbanwa)
Latest version: 0.0.1

# `@compai/font-noto-sans-tagbanwa`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-tagbanwa)
npm package: @compai/font-noto-sans-tirhuta
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-tirhuta)
Latest version: 0.0.1

# `@compai/font-noto-sans-tirhuta`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-sans-tirhuta)
npm package: @compai/font-noto-serif-dogra
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-serif-dogra)
Latest version: 0.0.1

# `@compai/font-noto-serif-dogra`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-serif-dogra)
npm package: @compai/font-noto-serif-kannada
Description: [**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-serif-kannada)
Latest version: 0.0.2

# `@compai/font-noto-serif-kannada`

[**Read the docs &rarr;**](https://components.ai/docs/typefaces/noto-serif-kannada)