https://github.com/roogue/osu-collector-node

An osu!Collector api wrapper
https://github.com/roogue/osu-collector-node

osu osu-api osugame typescript wrapper-api

Last synced: about 2 months ago
JSON representation

An osu!Collector api wrapper

• Host: GitHub
• URL: https://github.com/roogue/osu-collector-node
• Owner: roogue
• License: apache-2.0
• Created: 2022-05-23T02:57:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-17T14:10:38.000Z (over 2 years ago)
• Last Synced: 2024-10-05T13:07:46.753Z (3 months ago)
• Topics: osu, osu-api, osugame, typescript, wrapper-api
• Language: TypeScript
• Homepage:
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Osu-Collector-Node

Osu-Collector-Node is a wrapper for osu!Collector API which is written in typescript.

## Installation

```bash

npm i osu-collector-node

##

yarn add osu-collector-node

```

## Documentation

[Documentation](https://roogue.github.io/osu-collector-node/)

## Example Usage

```js

const { OsuCollectorNode } = require("osu-collector-node");

const cookie = "your-cookie";

const osuCollector = new OsuCollectorNode().setCookie(cookie);

// Fetch data of current logged-in user. 

osuCollector.getUserMe().then(console.log).catch(console.error);

// Fetch metadata (this does not requires a cookie)

osuCollector.getMetadata().then(console.log).catch(console.error);

// Typescript return type example

osuCollector.getUser<"Uploads">({ id: 2051389 }).then(console.log).catch(console.error);

```

For more information, check the [documentation](https://roogue.github.io/osu-collector-node/)

## Contributing

Typings are written manually by me, there's might be typo, missing or errors in props, once found, please open an issue or pull request for enhancement. Big appreciate.

## License

[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)