Skip to content

flazepe/ordr.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

o!rdr.js

axios ws

GitHub stars npm

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

• Download NPM and NodeJS

With GitHub :

• Download the project or clone it

• Go to the ordr.js folder and do npm install

• Require the client.js

With NPM :

• Download the project

• Do npm install ordr.js

• Require the library

Documentation

See the API documentation
See the WebSocket documentation
See the changelog

Example usage

The library can be used in both CommonJS and ES Modules

Using the library - API

const { Client } = require("ordr.js");
//OR
import { Client } from "ordr.js";

const client = new Client();

client.skins().then((data) => {
    console.log(data);
});

//OR

const myFunc = async () => {
    const data = await client.skins();
    console.log(data);
};

myFunc();

If you have an API key, you can specify it when initiating the client :

const client = new Client("API_KEY");

The library is async, be sure to use async functions or .then()

Using the library - WebSocket

const { Client } = require("ordr.js");
//OR
import { Client } from "ordr.js";

const client = new Client();

client.on("event", (data) => {
    console.log(data);
});

client.start();

List of events available here

Credits

o!rdr API

Copyright

See the license

About

A JavaScript library for interacting with the o!rdr API and WebSocket

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 100.0%