# bingo-generator

> simple bingo generator

Latest version **1.1.11** (published 2017-11-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install bingo-generator
pnpm add bingo-generator
yarn add bingo-generator
bun add bingo-generator
```

## 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 | 1.1.11 |
| Published | 2017-11-27 |
| First published | 2017-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | mikkel.djurhuus@gmail.com |
| Maintainers | mikkel-djurhuus |
| Keywords | bingo, generator, djur |

## Links

- npm: https://www.npmjs.com/package/bingo-generator
- Repository: https://github.com/MDJ-Mikkel-Djurhuus/bingo-generator
- Homepage: https://github.com/MDJ-Mikkel-Djurhuus/bingo-generator#readme
- Issues: https://github.com/MDJ-Mikkel-Djurhuus/bingo-generator/issues
- npm.io page: https://npm.io/package/bingo-generator

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## Recent versions

- 1.1.11 (latest) — 2017-11-27
- 1.1.10 — 2017-11-27
- 1.1.9 — 2017-11-27
- 1.1.8 — 2017-11-27
- 1.1.7 — 2017-11-27
- 1.1.3 — 2017-11-27
- 1.1.0 — 2017-11-27
- 1.0.0 — 2017-11-27

## README

# bingo-generator
![alt text](https://github.com/MDJ-Mikkel-Djurhuus/bingo-generator/raw/master/formatHTML.png "Bingo Bango!")

## Installation
npm install bingo-generator --save

## Usage
#### require
```javascript
var BingoGenerator = require("bingo-generator").default;
var generator = BingoGenerator();
generator.CreateBoard();
```
#### import
```javascript
import BingoGenerator from "bingo-generator";
let generator = BingoGenerator();
generator.CreateBoard();
```
#### parameters
```javascript
number_of_rows // default 3
number_of_cols // default 9
numbers_per_row // default 5
numbers_per_col // default 5
min_numbers_per_col // default 1
max_numbers_per_col // default 2
pool // default this.numberPool(numbers_per_col)
winner // defaull null
```
#### example
```javascript
import BingoGenerator from "bingo-generator";
let config = {
    numbers_per_row: 6,
    numbers_per_col: 4,
    winner: 15,
}
let generator = BingoGenerator(config);
```
resulting in the following config
```javascript
generator.config = {
    "number_of_rows": 3,
    "number_of_cols": 9,
    "numbers_per_col": 4,
    "numbers_per_row": 6,
    "min_numbers_per_col": 1,
    "max_numbers_per_col": 2,
    "pool": [
        [9, 3, 5, 2],
        [15, 10, 19, 11],
        [22, 20, 28, 24],
        [33, 36, 39, 32],
        [42, 45, 44, 48],
        [52, 59, 56, 57],
        [60, 68, 62, 65],
        [74, 70, 73, 77],
        [82, 80, 90, 83]
    ],
    "winner": 15
}
```
Calling createBoard() will return something like this
```javascript
console.log(generator.createBoard());
[ [ { col: 7, number: 73 },
    { col: 1, number: 15 },
    { col: 4, number: 45 },
    { col: 2, number: 22 },
    { col: 6, number: 60 },
    { col: 3, number: 39 } ],
  [ { col: 8, number: 80 },
    { col: 1, number: 10 },
    { col: 7, number: 70 },
    { col: 0, number: 3 },
    { col: 5, number: 52 },
    { col: 4, number: 48 } ],
  [ { col: 3, number: 32 },
    { col: 5, number: 57 },
    { col: 0, number: 5 },
    { col: 2, number: 24 },
    { col: 6, number: 68 },
    { col: 8, number: 82 } ] ]
```
 (with the winner defined, a board will always contain a cell with the winning number)

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