Light

thelearneer / croyale Goto Github PK

View Code? Open in Web Editor NEW

13.0 4.0 3.0 423 KB

Easy to use asynchronous Wrapper for RoyaleAPI.

License: MIT License

JavaScript 100.00%

clash-royale cr-api clashroyale

croyale's Introduction

An easy to use Asynchronous wrapper to interact with RoyaleAPI.com

⚠️ IMPORTANT ⚠️

RoyaleAPI.com has been shutdown by its developers. Time to use the official clash royale API.

Features

Object Oriented
User friendly
Maximum coverage of the API
Cache, Rate-limit and error handling
Utility functions

Installation

node.js 8.0.0 or newer is required

Stable: npm install croyale

Master: npm install TheLearneer/croyale

master branch might contian some bugs, so if you are interested in bug free code then install stable, but if you are want to have the latest of the wrapper then install master branch.

Example Usage

const { Client } = require('croyale');
const client = new Client('super secret token');

client.Users.getProfile('CVLQ2GV8', { keys: ['tag', 'name'] })
	.then(player => {
		console.log(`Name of the player with tag ${player.tag} is ${player.name}`);
	})
	.catch(console.error);

Credits

The major credit for the existence of this wrapper goes to the developers of the api; SML and Selfish.
In the meantime I would like to thank every individual person who have directly or indirectly helped me.

Links

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.
Make sure the changes you made aren't breaking things and are working fine if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Croyale Server.

croyale's People

Contributors

Stargazers

Watchers

Forkers

mariowhowrites blackholefox xysdavid

croyale's Issues

Implement pagination

Implement pagination for the possible endpoints (i.e. the endpoints that return an array) as described here here

get ratelimit

Hi, it would be great. If there is an opportunity to get ratelimit. Here so for example. Where var ratetime is the client's object.
https://gist.github.com/Friday14/d7733cac6a8b2cba8ef0bc7a9a65a369

Allowing Invalid Tags to be submitted leads to unusable error being returned

So the issue seems to be that the wrapper isnt catching invalid tags, leading to something returning an unintelligible mess that messes with other error checking logic. TypeError: err.includes is not a function is what shows up when I run a getplayer on 3333

Getting clan chat

How can I get clan chat?

Wrapper not catching 400 bad request errors from API on clanChest.

(Issue title pretty self explanatory)

Expected Result: Upon getting clanChest stats of invalid clan tag, an Improper request error from wrapper.

Actual Result: 400 bad request error from the API itself.

Error type inconsistencies

Offending line on: https://github.com/TheLearneer/croyale/blob/master/src/client.js line 85.

When submitting a tag that is not registered to a player, it returns an error containing a 404 in a string. However, when submitting nothing it returns an error in a object type, which leads to impossibility in checking which it was on data returning.

Player chest data types are inconsistent

Implement caching

Implement caching so that unnecassary request wont be made to the API for the time being.

Missing Endpoints

Do not Enough
/players?/:Tag/battles?

At the moment it is impossible to get the number of matches.
It will be great if you add it.

Missing Endpoints

These are the functionality (endpoints) missing in the wrapper at current:

Keys and Exclude work even if parameter is not an array

Currently the keys, Exclude and other query parameters work even if they are not array. There should be an better check to see if its actually an array.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.