# ngx-combination-generator
> Angular Library built on the top of the combination generator package of @udjamaflip. This library allows you to provide a list of characters and a min/max length of output string to generate a list of all possible combinations (or non-unique permutations
Latest version **2.0.0** (published 2018-05-14) · MIT license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install ngx-combination-generator
pnpm add ngx-combination-generator
yarn add ngx-combination-generator
bun add ngx-combination-generator
```
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-05-14 |
| First published | 2018-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 44.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Andy Sharman and Anthony Nahas |
| Maintainers | anthonynahas |
| Keywords | angular, library, cli, npm, combinations, generator, string, permutations |
## Links
- npm: https://www.npmjs.com/package/ngx-combination-generator
- Repository: https://github.com/anthonynahas/combination-generator
- Issues: https://github.com/anthonynahas/combination-generator/issues
- npm.io page: https://npm.io/package/ngx-combination-generator
## Alternatives
- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads
## Recent versions
- 2.0.0 (latest) — 2018-05-14
- 1.0.3 — 2018-04-22
- 1.0.2 — 2018-04-18
- 1.0.1 — 2018-04-18
- 1.0.0 — 2018-04-18
## README
# combination-generator - Angular Library built on the top of the combination generator package of @udjamaflip in order to generate all possible (unique) permutations of a provided list of characters.
This library allows you to provide a list of characters and a min/max length of output string to generate a
list of all possible combinations (or non-unique permutations of those characters). This is useful for getting a
list of characters for brute-forcing or to test password combinations (e.g: for ngx-material-password-strength)
_NB_: This project is originally forked from [udjamaflip/combination-generator](https://github.com/udjamaflip/combination-generator).
[](https://badge.fury.io/js/ngx-combination-generator),
[](https://anthonynahas.github.io/combination-generator)
[](https://coveralls.io/github/anthonynahas/combination-generator?branch=master)
[](https://david-dm.org/anthonynahas/combination-generator)
[](https://david-dm.org/anthonynahas/combination-generator#info=devDependencies)
[](https://greenkeeper.io/)
## Demo
View all the directives in action at https://anthonynahas.github.io/combination-generator
## Dependencies - Angular V6 is now supported
* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with 2.0.0)
## Installation
Install above dependencies via *npm*.
Now install `ngx-combination-generator` via:
```shell
npm install --save ngx-combination-generator
```
*NB: Global installation is required for CLI commands to work correctly*
```shell
npm install -g ngx-combination-generator
```
---
##### SystemJS
>**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.
In your systemjs config file, `map` needs to tell the System loader where to look for `ngx-combination-generator`:
```js
map: {
'ngx-combination-generator': 'node_modules/ngx-combination-generator/bundles/ngx-combination-generator.umd.js',
}
```
---
Once installed you need to import the main module:
```js
import { NgxCombinationGeneratorModule } from 'ngx-combination-generator';
```
The only remaining part is to list the imported module in your application module. The exact method will be slightly
different for the root (top-level) module for which you should end up with the code similar to (notice ` NgxCombinationGeneratorModule .forRoot()`):
```js
import { NgxCombinationGeneratorModule } from 'ngx-combination-generator';
@NgModule({
declarations: [AppComponent, ...],
imports: [NgxCombinationGeneratorModule.forRoot(), ...],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
Other modules in your application can simply import ` NgxCombinationGeneratorModule `:
```js
import { NgxCombinationGeneratorModule } from 'ngx-combination-generator';
@NgModule({
declarations: [OtherComponent, ...],
imports: [NgxCombinationGeneratorModule, ...],
})
export class OtherModule {
}
```
## Usage
### with Angular
Inject the `NgxCombinationGeneratorService` in your component and go! See below
```ts
import {Component, OnInit} from '@angular/core';
import {NgxCombinationGeneratorService} from 'ngx-combination-generator';
@Component({
selector: 'app-your-component',
templateUrl: './your.component.html',
styleUrls: ['./your.component.scss']
})
export class YourComponent implements OnInit {
min = 1;
max = 2;
selectedChars: string;
charsList: string[] = ['a', 'b', 'c', '1', '2', '3'];
combinationsList: string[] = [];
constructor(public generator: NgxCombinationGeneratorService) {
}
generate() {
this.combinationsList = this.generator.loadCombinationList(this.charsList, this.min, this.max);
console.log("this.combinationsList = ", this.combinationsList);
// output = ["a", "b", "c", "1", "2", "3", "aa", "ab", "ac", "a1", "a2", "a3", "ba", "bb", "bc", "b1", "b2", "b3", "ca",
// " cb", "cc", "c1", "c2", "c3", "1a", "1b", "1c", "11", "12", "13", "2a", "2b", "2c", "21", "22", "23", "3a", "3b", "3c",
// " 31", "32", "33"]
}
}
```
#### Expected input
The input is expected to be an array of characters expected to be used i.e.
```javascript
var myCharacterList = ['a','0','R','3','#','f','P','x'];
```
#### Code
Using that array we can pass it through as the first parameter, and then specify the minimum and maximum length of the combinations to be generated
```javascript
var generator = require('node_modules/generator.js'),
myCombinations = generator(myCharacterList, 1, 2); //1 is the shorted a combo will be, 2 is the longest
console.log(myCombinations);
```
#### Output
This will output a JSON string containing all possible combinations like so:
```javascript
["a","0","R","3","#","f","P","x","aa","a0","aR","a3","a#","af","aP","ax","0a","00","0R","03",
"0#","0f","0P","0x","Ra","R0","RR","R3","R#","Rf","RP","Rx","3a","30","3R","33","3#","3f","3P","3x","#a","#0","#R","#3","##","#f","#P","#x","fa","f0","fR","f3","f#","ff","fP","fx","Pa","P0","PR","P3","P#","Pf","PP","Px","xa","x0","xR","x3","x#","xf","xP","xx"]
```
### Using as CLI (Runtime)
You can use the command in 2 a few different ways using an input file, or an inline comma-separated list i.e.
`generate-combos a,0,R,3,#,f,P,x 1 2`
You can pipe the output in to a file like so:
`generate-combos a,0,R,3,#,f,P,x 1 2 >> my-list-of-character-combinations.json`
You can also specify an input file, the file must contain the same expected input i.e.
*my-input-list.json*
`a,0,R,3,#,f,P,x 1 2`
Then run the command:
`generate-combos my-input-list.json 1 2`
or use the same command and pipe in to a JSON file for further usage:
`generate-combos my-input-list.json 1 2 >> my-list-of-character-combinations.json`
## Other Angular Libraries
- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)
- [ngx-material-pages](https://github.com/AnthonyNahas/ngx-material-pages)
- [ngx-material-contacts](https://github.com/AnthonyNahas/ngx-material-contacts)
- [ngx-material-password-strength](https://github.com/AnthonyNahas/ngx-material-password-strength)
- [ngx-material-faq](https://github.com/AnthonyNahas/ngx-material-faq)
## License
Copyright (c) 2018 anthonynahas. Licensed under the MIT License (MIT)
---
_Source: https://npm.io/package/ngx-combination-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._