Dahvidclient NPM

About The Project

DahvidClient is a typescript Riot API wrapper aimed at providing a simplistic way to access the riot API, with typings.

Built With

Prerequisites

Obtain a riot API token, this can be obtained from (https://developer.riotgames.com/). Place this token in your environmental variabes for your serveror into a .env file.

Installation

npm install --save dahvidclient

Usage

Base:

const { DahvidClient } = require("dahvidclient");

Example Application (with env):

npm install --save-dev dotenv

// .env
RIOT_API_KEY=YOUR_API_KEY_HERE

// index.js
const { DahvidClient, RegionToContinentMap } = require("dahvidclient");

const api = new DahvidClient({ apiKey: process.env.RIOT_API_KEY });

(async () => {
  const summoner = await api.summoner.byName("possum2002", "oce") // get account information
  const cairoPuuid = summoner.puuid; 
  const matchList = await api.match.byPuuid(cairoPuuid, RegionToContinentMap["oce"], { count: 1 }); // get the most recent game id
  const match = await api.match.matchById(matchList[0], RegionToContinentMap["oce"]); // get match information with game id
  const cairo = match.info.participants.find((p) => p.puuid === cairoPuuid); 
  
  console.log(`KDA: ${cairo.kills} / ${cairo.deaths} / ${cairo.assists}`)
})();

node -r dotenv/config index.js

Roadmap

Finish mapping API to /src/resources
Finish types
Queue & rate limiting
Better Documentation & examples

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!