https://github.com/ribeirogab/scuttle-crab

A Node.js wrapper for the League of Legends Gamepedia REST API.
https://github.com/ribeirogab/scuttle-crab

api league-of-legends lol nodejs typescript wrapper

Last synced: about 2 months ago
JSON representation

A Node.js wrapper for the League of Legends Gamepedia REST API.

• Host: GitHub
• URL: https://github.com/ribeirogab/scuttle-crab
• Owner: ribeirogab
• Created: 2020-06-27T13:39:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T19:32:56.000Z (almost 2 years ago)
• Last Synced: 2024-08-07T18:54:48.045Z (5 months ago)
• Topics: api, league-of-legends, lol, nodejs, typescript, wrapper
• Language: TypeScript
• Homepage:
• Size: 598 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



# Scuttle Crab

> A wrapper for the LOL Gamepedia REST API.

For more information, please refer to [API documentation](https://lol.gamepedia.com/Help:API_Documentation).

## Getting Started

### Installation

if you use npm

```bash

npm install scuttle-crap

```

if you use yarn

```

yarn add scuttle-crap

```

### Example 1

> Feature: champions > find

```js

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

```js

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](https://github.com/ribeirogab/scuttle-crab/tree/master/examples/doc/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`

### Step 2

- **HACK AWAY!** 🔨🔨🔨

### Step 3

- 🔃  Create a new pull request using `https://github.com/ribeirogab/scuttle-crab/compare/`.

---

## Contributors

|  |  |  |  |  |  |

|:-:|:-:|:-:|:-:|:-:|:-:|

## Author

| [
@ribeirogab](https://github.com/ribeirogab) |

| :---: |

---

## FAQ

- **How do I do *specifically* so and so?**

    - No problem! Just do this.

---

## Support

Contact me!

- E-mail `[email protected]`

---

## Licensa

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

- **[MIT license](http://opensource.org/licenses/mit-license.php)**