nodesu
Version:
a node.js osu! api wrapper
106 lines (66 loc) • 4.69 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><div align="center">
<h1>nodesu!</h1>
a node.js osu! api wrapper.
<p>
<p><a href="https://nodei.co/npm/nodesu/"><img src="https://nodei.co/npm/nodesu.png?downloads=true&stars=true" alt="NPM"></a></p>
</p>
</div>
<h2>Installing</h2>
<p><strong>node.js >=4.0.0</strong> must be used for this library to work!</p>
<pre class="prettyprint source"><code>$ npm install nodesu
# or install from GitHub
$ npm install nicholastay/nodesu
</code></pre>
<p><em>note!: nodesu has been rewritten from the ground up since v0.6.0. All sections of programs which utilize this library probably have to be rewritten if migrating from previous versions!</em></p>
<h2>Getting Started</h2>
<pre class="prettyprint source lang-js"><code>const Nodesu = require('nodesu');
const api = new Nodesu.Client('_api-key-here_');
// ... see docs/Modules:Components - typical usage = api.<component>.<function>();
// most functions return Promise objects.
// eg: get beatmap data
api.beatmaps
.getByBeatmapId('646609')
.then(console.log); // outputs to stdout.
</code></pre>
<h2>Links</h2>
<ul>
<li><strong>Main repository</strong>: https://github.com/nicholastay/nodesu/</li>
<li><strong>Documentation</strong>: https://nicholastay.github.io/nodesu/</li>
</ul>
<h2>Documentation note</h2>
<p>Most of what you want to find should be under the "Client" class, or the Modules section (categorized classes).</p>
<h2>Contributing</h2>
<p>Contributions are much welcome via issues or pull requests.</p>
<h2>License</h2>
<p>Zlib/libpng license. Full text in the root of this repository.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Components.html">Components</a></li><li><a href="module-CustomClasses.html">CustomClasses</a></li><li><a href="module-Enums.html">Enums</a></li><li><a href="module-Errors.html">Errors</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="module-Components.BeatmapsComponent.html">BeatmapsComponent</a></li><li><a href="module-Components.MultiComponent.html">MultiComponent</a></li><li><a href="module-Components.ReplayComponent.html">ReplayComponent</a></li><li><a href="module-Components.ScoresComponent.html">ScoresComponent</a></li><li><a href="module-Components.UserComponent.html">UserComponent</a></li><li><a href="module-CustomClasses.Beatmap.html">Beatmap</a></li><li><a href="module-CustomClasses.BeatmapScore.html">BeatmapScore</a></li><li><a href="module-CustomClasses.Multi.html">Multi</a></li><li><a href="module-CustomClasses.MultiGame.html">MultiGame</a></li><li><a href="module-CustomClasses.MultiMatch.html">MultiMatch</a></li><li><a href="module-CustomClasses.MultiScore.html">MultiScore</a></li><li><a href="module-CustomClasses.ReplayData.html">ReplayData</a></li><li><a href="module-CustomClasses.Score.html">Score</a></li><li><a href="module-CustomClasses.User.html">User</a></li><li><a href="module-CustomClasses.UserEvent.html">UserEvent</a></li><li><a href="module-CustomClasses.UserScore.html">UserScore</a></li><li><a href="module-Errors.OsuApiError.html">OsuApiError</a></li><li><a href="Requester.html">Requester</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ApprovalStatus">ApprovalStatus</a></li><li><a href="global.html#Converts">Converts</a></li><li><a href="global.html#Genre">Genre</a></li><li><a href="global.html#Language">Language</a></li><li><a href="global.html#LookupType">LookupType</a></li><li><a href="global.html#Mode">Mode</a></li><li><a href="global.html#Mods">Mods</a></li><li><a href="global.html#MultiScoringType">MultiScoringType</a></li><li><a href="global.html#MultiTeam">MultiTeam</a></li><li><a href="global.html#MultiTeamType">MultiTeamType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sat Apr 11 2020 14:41:31 GMT+1000 (GMT+10:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>