Scuttle-crab NPM

Scuttle Crab

A wrapper for the LOL Gamepedia REST API.

For more information, please refer to API documentation.

Getting Started

Installation

if you use npm

npm install scuttle-crap

if you use yarn

yarn add scuttle-crap

Example 1

Feature: champions > find

const { champions } = require('scuttle-crab');

async function main() {
  const championsRepository = champions();

  const allChampions = await championsRepository.find({});

  console.log(allChampions);
}

main();

Example 2

Feature: champions > find

const { champions } = require('scuttle-crab');

async function main() {
  const championsRepository = champions();

  const NameOfTenChampions = await championsRepository.find({
     order_by: { field: { name: 'Name' }, order: 'DESC' }, // order by name
     fields: [{ name: 'Name' }], // only field name
     limit: 10,
  });

  console.log(NameOfTenChampions);
}

main();

Features

Champions:
- Find;
Current Leagues:
- Find;
Champion Flashcards:
- Find;
Chroma Set:
- Find;
Chromas:
- Find;
Players:
- Find;
Scoreboard Games:
- Find;

Contributing

To get started...

Step 1

Option 1
- 🍴 Fork this repo!
Option 2
- 👯 Clone this repo to your local machine using git clone https://github.com/ribeirogab/scuttle-crab.git