Skip to content
This repository has been archived by the owner on Mar 9, 2020. It is now read-only.
/ croyale Public archive

Easy to use asynchronous Wrapper for RoyaleAPI.

License

Notifications You must be signed in to change notification settings

bsantosh909/croyale

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

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.

About

Easy to use asynchronous Wrapper for RoyaleAPI.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published