4.0.0 • Published 2 months ago
ordr.js v4.0.0
o!rdr.js
ordr.js is a Node.js module that allows you to easily interact with the o!rdr API and WebSocket.
- Promise-based
- Performant
- 100% coverage of the o!rdr API and WebSocket
Installation
- Install NodeJS
- Run
npm install ordr.js
Documentation
Example usage
API
import { Client } from "ordr.js";
const client = new Client();
const skins = await client.getSkins();
console.log(skins);
API key
If you have an API key, you can specify it when initiating the client:
const client = new Client("API_KEY");
Sending a replay
You can send a replay by doing the following:
client.sendRender({
...
replay: "https://domain.tld/path/to/your/file.osr",
...
})
client.sendRender({
...
replay: "path/to/your/file.osr",
...
})
const file = readFile("path/to/your/file.osr");
client.sendRender({
...
replay: file,
...
})
const file = createReadStream("path/to/your/file.osr");
client.sendRender({
...
replay: file,
...
})
WebSocket
import { Client, Events } from "ordr.js";
const client = new Client();
client.on(Events.Connected, () => console.log("Client connected!"));
client.start();
List of events available here
Credits
Copyright
See the license
4.0.0
2 months ago
3.13.0
3 months ago
3.12.0
10 months ago
3.11.2
1 year ago
3.11.1
1 year ago
3.11.0
2 years ago
3.10.1
2 years ago
3.10.0
2 years ago
3.9.0
2 years ago
3.8.1
2 years ago
3.8.0
2 years ago
3.7.0
2 years ago
3.6.0
3 years ago
3.5.0
3 years ago
3.4.0
3 years ago
3.3.1
3 years ago
3.3.0
3 years ago
3.3.2
3 years ago
3.2.1
3 years ago
3.1.3
3 years ago
3.1.2
3 years ago
3.2.0
3 years ago
3.1.1
3 years ago
3.1.0
3 years ago
3.0.0
3 years ago
2.0.0
3 years ago
1.1.0
3 years ago
1.0.0
3 years ago