# largest-remainder-round

> A library to added a largest remainder round functionality to positive number arrays

Latest version **1.1.0** (published 2020-05-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install largest-remainder-round
pnpm add largest-remainder-round
yarn add largest-remainder-round
bun add largest-remainder-round
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-05-17 |
| First published | 2020-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Man Nguyen |
| Maintainers | mango-man |
| Keywords | ["largestremainderround", "round"] |

## Links

- npm: https://www.npmjs.com/package/largest-remainder-round
- Repository: https://github.com/ManNguyen/LargestRemainderRound
- Homepage: https://github.com/ManNguyen/LargestRemainderRound#readme
- Issues: https://github.com/ManNguyen/LargestRemainderRound/issues
- npm.io page: https://npm.io/package/largest-remainder-round

## Recent versions

- 1.1.0 (latest) — 2020-05-17
- 1.0.7 — 2020-04-17
- 1.0.6 — 2020-04-04
- 1.0.4 — 2020-04-04
- 1.0.3 — 2020-03-30
- 1.0.2 — 2020-03-30
- 1.0.1 — 2020-03-30
- 1.0.0 — 2020-03-29

## README

# Largest Remainder Round
Add a `spread`  function to the array object which "spread" the number array in such way that the total amount is exact without changing the percentage of each element. The "spread" action uses the [Largest Remainder Method](https://en.wikipedia.org/wiki/Largest_remainder_method). 

`spread` is useful when you want to get the percentage of a number array and keep the total percentage at 100.


## Installation

a) Use the Node package manager [npm](https://www.npmjs.com/package/largest-remainder-round) to install.

```bash
npm i largest-remainder-round
```


b) Use CDN

`<script src="https://unpkg.com/largest-remainder-round"></script>`

## Usage

```javascript
require ('largest-remainder-round');

var arr = [1000,1000,5000,1000]

arr.spread() // returns [13, 13, 62, 12]
arr.spread(50) // returns [7, 6, 31, 6]
arr.spread(1000) // returns [125, 125, 625, 125]

//second parameters is for number of digits after decimal place
arr.spread(50,2) // returns [6.25, 6.25, 31.25, 6.25 ]
arr.spread(undefined,1) // return [12.5, 12.5, 62.5, 12.5]


//IF the input array is an obj array, then you need to put in the configurations
  var ObjArr = [
    { name: "Batman", vote: 1000 },
    { name: "Superman",  vote: 1000 },
    { name: "Wonder Woman", vote: 5000},
    { name: "The Flash", vote: 1000 }
];

ObjArr.spread({ prop: "vote", spreadTo: "percentage", seats:50, decimals:2 })
/* returns
[ 
  { name: 'Batman', vote: 1000, percentage: 6.25 },
  { name: 'Superman', vote: 1000, percentage: 6.25 },
  { name: 'Wonder Woman', vote: 5000, percentage: 31.25 },
  { name: 'The Flash', vote: 1000, percentage: 6.25 }
]*/

//The obj array config need to know at least which 'prop'perty to use for the calculation
ObjArr.spread({ prop: "vote" })
/* returns
[
  { name: 'Batman', vote: 1000, vote_spread: 13 },
  { name: 'Superman', vote: 1000, vote_spread: 13 },
  { name: 'Wonder Woman', vote: 5000, vote_spread: 62 },
  { name: 'The Flash', vote: 1000, vote_spread: 12 }
]*/

```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

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