# vc-weighted-random

> Weighted random

Latest version **1.1.0** (published 2022-02-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install vc-weighted-random
pnpm add vc-weighted-random
yarn add vc-weighted-random
bun add vc-weighted-random
```

## 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.0 |
| Published | 2022-02-08 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vencent Lum |
| Maintainers | vencent_lum |
| Keywords | weighted, random, weighted-random, 权重随机, 随机, 随机抽奖 |

## Links

- npm: https://www.npmjs.com/package/vc-weighted-random
- npm.io page: https://npm.io/package/vc-weighted-random

## Recent versions

- 1.1.0 (latest) — 2022-02-08
- 1.0.3 — 2022-01-25
- 1.0.2 — 2022-01-25
- 1.0.1 — 2022-01-24
- 1.0.0 — 2022-01-24

## README

### 中文  |  [English](./README-en.md)

# 加权随机取值

#### 介绍
基于 es6+ 的加权随机取值，支持单一取值和连续不重复取值。本应用无第三方依赖包，开箱即用。常见应用场景有：概率不等的抽奖 等。


#### 安装教程

##### 使用 ```npm``` 和 ```yarn```
```shell script
npm i vc-weighted-random

yarn add vc-weighted-random
```
个人推荐使用 [pnpm](https://pnpm.io/) 代替 ```npm``` 作为包管理器
##### 使用 ```pnpm```
```shell script
pnpm install vc-weighted-random
```
 
##### 在浏览器环境中直接使用
先克隆项目至本地（或者下载```releases```包）
```shell script
git clone https://gitee.com/Vencentlum/weighted-random.git
```
随后将本地目录下的index.js拷贝至你的项目中，最后通过script标签引入即可。
```shell script
// 全局变量
window.VC_weight_random
```

#### 使用说明
```shell script
const VC_fn = require('vc-weighted-random')

VC_fn(params, option);
```
|  参数   | 说明  | 补充说明 |
|  ----  | ----  | --- |
| VC_fn  | 可能返回的值 null | key | key[] | 详情请查看example的测试用例 |
| params  | Map数据结构,key可以是任意类型，value是权重值 |  Map的value只接受正整数 |
| option  | Object | 见下方    |

```shell script
// default
const option = {
    continuous: false, // boolean,是否连续取值，直到取完,为true时返回数组，为false时返回Map的key
    showErrorMsg: true // boolean,参数检查出现错误时是否打印错误信息
}
```
#### 测试
克隆本项目至你的本地，在此项目根目录下(需要```node.js```环境)
```shell
node example/index.js
```

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