# permutated

> 𝓟ℯ𝓇𝑚𝓊𝓉𝒶𝓉ℯ𝒹: get all available combinations

Latest version **2.0.0** (published 2019-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install permutated
pnpm add permutated
yarn add permutated
bun add permutated
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-07-26 |
| First published | 2018-07-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Carlos Abraham |
| Maintainers | abranhe |
| Keywords | permutation, permutated, permutator, order-changer, math, discrete-math |

## Links

- npm: https://www.npmjs.com/package/permutated
- Repository: https://github.com/abranhe/permutated
- Homepage: https://p.abranhe.com/permutated
- npm.io page: https://npm.io/package/permutated

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-07-26
- 1.0.1 — 2018-07-27
- 1.0.0 — 2018-07-27

## README

<p>
	<a href="https://www.npmjs.com/package/permutated">
		<img src="https://cdn.abranhe.com/projects/permutated/logo.svg" width="30%">
	</a>
	<br>
</p>

# 𝓟ℯ𝓇𝑚𝓊𝓉𝒶𝓉ℯ𝒹

> Get all available combinations

[![](https://img.shields.io/travis/abranhe/permutated.svg?logo=travis)](https://travis-ci.org/abranhe/permutated)
[![](https://abranhe.com/badge.svg)](https://github.com/abranhe)
[![](https://cdn.abranhe.com/badges/cash-me.svg)](https://cash.me/$abranhe)
[![](https://cdn.abranhe.com/badges/patreon.svg)](https://patreon.com/abranhe)
[![](https://img.shields.io/github/license/abranhe/permutated.svg)](https://github.com/abranhe/permutated/blob/master/license)
[![](https://img.shields.io/npm/v/permutated.svg)](https://npmjs.com/package/permutated)

<br>

In mathematics, permutation is the act of arranging the members of a set into a sequence or order, or, if the set is already ordered, rearranging (reordering) its elements a process called permuting. Permutations differ from combinations, which are selections of some members of a set regardless of order.

[Read More...](https://en.wikipedia.org/wiki/Permutation)

### Complexity?

7 letters word ~> [7!](https://www.google.com/search?q=7!)  ~> 5040 available combinations to generate.

## Install

```
$ npm install permutated
```

## Usage

```js
const permutated = require('permutated');

permutated('abc'));
//=> [ 'abc', 'acb', 'bac', 'bca', 'cab', 'cba' ]

permutated.numberOfPermutations('1234567'));
//=> 5040
```

## API

### permutated(word)

Return type: `string[] | string`

Return all the permuations available from a string.

#### word

Type: `string`

The string to permutate.

## numberOfPermutations(word)

Return Type: `number`

Get the number of permuations avilable in a string.

#### word

Type: `string`

The string to permutate.

## Related

- [all-words](https://github.com/abranhe/all-words): Generate all available words super fast

## License

MIT © [Carlos Abraham](https://abranhe.com)

---
_Source: https://npm.io/package/permutated · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
