Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blinet/ratev
https://github.com/blinet/ratev
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/blinet/ratev
- Owner: blinet
- License: apache-2.0
- Created: 2023-01-28T02:47:14.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-28T02:52:09.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T18:30:07.796Z (7 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **rate value**
**ratev is a simple rate value module to rate array of object and return value based on percent 0.1 or higher than 100**
- [Installation](#installation)
- [Example](#example)
- [Methods](#methods)
- [push](#push)
- [edit](#edit)
- [delete](#delete)
- [Properties](#properties)
- [value](#value)
- [data](#data)
# **Installation**
```sh-session
npm install ratev
yarn add ratev
```
### CommonJS
```js
const Ratev = require("ratev");
const MyfirstRate = new Ratev();
```
### ES6
```js
import Ratev from "ratev";
const MyfirstRate = new Ratev();
```
## **Example**
```js
const Ratev = require("ratev");
//new Ratev support array of object or ...args of object
const MyfirstRate = new Ratev([
{ rate: 90, value: "BRONZE" }, //90% chance to return BRONZE
{ rate: 70, value: "SILVER" }, //70% chance to return SILVER
{ rate: 50, value: "GOLD" }, //50% chance to return GOLD
{
rate: 20,
value: "PLATINUM", //20% chance to return PLATINUM
},
{
rate: 15,
value: "DIAMOND", //15% chance to return DIAMOND
},
{
rate: 10,
value: "MASTER", //10% chance to return MASTER
},
{
rate: 0.1,
value: "GRANDMASTER", //0.1% chance to return GRANDMASTER
},
]);
setInterval(function () {
console.log(MyfirstRate.value); //return random value based on rate
}, 1000);
```
## **Methods**
### **`push`**
#### push new value if ther duplicate value it will be replace with new rate
```js
MyfirstRate.push(...);
//or
MyfirstRate.push([...]);
```
### **EX**
#### **push(...\);**
```js
MyfirstRate.push({ rate: 0.1, value: "CHALLENGER" });
//return array of object with new value
```
#### **push([...\]);**
```js
MyfirstRate.push([
{ rate: 0.1, value: "CHALLENGER" },
{ rate: 0.1, value: "GRANDMASTER" },
]);
//return array of object with new value
```
### **`edit`**
#### edit multiple rate by push new rate with same value
### `same as push but it just edit rate`
```js
MyfirstRate.push(...);
//or
MyfirstRate.push([...]);
```
### **`delete`**
#### delete object from array of object by value you can delete multiple value by passing multiple value
```js
MyfirstRate.delete(...);
```
### **EX**
```js
MyfirstRate.delete("BRONZE", "SILVER", "GOLD");
//return array of object without BRONZE,SILVER,GOLD
```
## **Properties**
### **`value`**
#### return random value based on rate
```js
MyfirstRate.value;
```
### **`data`**
#### return array of object
```js
MyfirstRate.data;
```
## Links
- [Twiter](https://twitter.com/onlyarth)
- [Github](https://github.com/4i8)
## License
- [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)