https://github.com/iseizuu/osu-wrapper
An easy wrapper for osu API.
https://github.com/iseizuu/osu-wrapper
osu osu-api osu-api-wrapper osu-framework osu-libraries
Last synced: 5 months ago
JSON representation
An easy wrapper for osu API.
- Host: GitHub
- URL: https://github.com/iseizuu/osu-wrapper
- Owner: iseizuu
- License: mit
- Created: 2021-02-15T15:02:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-04T05:12:34.000Z (over 5 years ago)
- Last Synced: 2025-08-28T17:55:16.832Z (10 months ago)
- Topics: osu, osu-api, osu-api-wrapper, osu-framework, osu-libraries
- Language: TypeScript
- Homepage:
- Size: 196 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# osu-wrapper
An easy wrapper for osu API and support intellisense.
- [Documentation](https://iseizuu.github.io/osu-wrapper/)
- [Official Osu! Docs](https://github.com/ppy/osu-api/wiki)
## Installing
[](https://nodei.co/npm/osu-wrapper)
```sh
#npm
npm install osu-wrapper
#yarn
yarn add osu-wrapper
```
## Example Usage
- grab your own token at [HERE](https://osu.ppy.sh/p/api/)
### getUser
###### Methods
- **getUser**(option: userOpt)
```js
const { Osu } = require("osu-wrapper");
const client = new Osu("ur_token");
async function user() {
const result = await client.getUser({ u: "ivoskydeav", m: "3" });
console.log(result);
return result;
}
user()
```
### getBeatmaps
###### Methods
- **getBeatmaps**(option: beatOpt)
```js
const { Osu } = require("osu-wrapper");
const client = new Osu("ur_token");
async function getBeatmaps() {
const result = await client.getBeatmaps({ b: 309176 });
console.log(result);
return result;
}
getBeatmaps()
```
~~For more information go to documentation~~
## n.b
Actually i don't know how to write the documentation, but i hope you will understand and if you have any question feel free to join my [Discord Server](https://discord.gg/5DKMn8TMFx)
© [Aizuu](https://github.com/iseizuu)