3.0.1 • Published 8 months ago
mrivals v3.0.1
Instalation
This module uses
flaresolverrto fetch data You need to have anflaresolverrinstance to use this library, using the default docker image is fine.
To install use:
npm i mrivalsSet enviroments variables
This programs defaults this env to http://localhost:8191
You have to set the FLARESOLVERR_URL enviroment variable to the url of your flaresolverr instance.
Also you can pass it as an options of API.fetchUser
await API.fetchUser(username, { flaresolverrUrl: 'https://some.flaresolverr.domain:8191' });Usage
There is only one static function that takes an username.
/* returns an API class instance with the data already fetched */
await API.fetchUser(username); // user#tagYou must call API.fetchUser before using any other method.
| Methods | Description |
|---|---|
| info | user and mmr info |
| overview | overview stats |
| heroes | heroes stats |
| roles | roles stats |
| peakRank | peak rank |
| raw | return raw response |
Example code
Feel free to use my riot username for testing
const { API } = require('mrivals');
try {
const user = await API.fetchUser('ifraan');
console.log('User:', user.info());
console.log('Overview:', user.overview());
console.log('Heroes:', user.heroes());
console.log('Roles:', user.roles());
console.log('Peak MMR:', user.peakRank());
console.log('Raw:', user.raw());
} catch (e) {
console.log(e);
/* Error: We could not find the player [player]. */
}Disclaimer
This project is fully for educational purposes and if you want to use the marvel rivals api in a production/commertial enviroment you should ask or email the guys at TRNetwork.