rjs-api v0.9.0

rjs-api

Is a simple api for revolt bots in JavaScript

• Fast
• Simple
• Light

Note: requires *ES Modules, Node ^18 or Node ^17.5.0 and the flag --experimental-fetch

Example

// Import the API and WebSocket
import { Api, WebSocket } from 'rjs-api'

//Create Api object
const api = Api('TOKEN_BOT')

//GET method
const userbot = await api.users['@me'].get()

//POST method
api.channels['01FSMFSXJBYAAYSVCW9JGXXCJ0'].messages.post({
    body: { 
        content: 'Hi, Im ' + userbot.username + ', Im ready'
     }
})

//create a WebSocket connection
const ws = WebSocket('TOKEN_BOT')

//Listening events
ws.on('message', (data) => {
    const event = JSON.parse(data.toString())

    if (event.type !== 'Message') return

    if (event.content.startsWith('!ping'))
    
        return api.channels[event.channel].messages.post({
            body: JSON.stringify({
                content: 'pong!'
            })
        })
})

Connect to WebSocket and recive events in real time, You can explore all api routes as a property and use the get(), post(), put() or patch() method on any endpoint

get(getOptions): Promise\

Apply a GET to the generated route

Params:

• getOptions?: Object
  • query?: Object or String - Properties passed in the object are added in the query.
  • headers?: Object - Extra headers can be added and override the default ones.

Returns: A Promise with the information in a JSON received from the API. In case of an error receives an Object with error information.

post(postOptions?): Promise\

Apply a POST to the generated route

Params:

• postOptions?: Object
  • body?: Object or String - Data to send in the post
  • query?: Object or String - Properties passed in the object are added in the query.
  • headers?: Object - Extra headers can be added and override the default ones.

Returns: A Promise with the information in a JSON received from the API. In case of an error receives an Object with error information.

patch(patchOptions?): Promise\

Apply a PATCH to the generated route

Params:

• patchOptions?: Object
  • body?: Object or String - Data to send in the patch
  • query?: Object or String - Properties passed in the object are added in the query.
  • headers?: Object - Extra headers can be added and override the default ones.

Returns: A Promise with the information in a JSON received from the API. In case of an error receives an Object with error information.

put(putOptions?): Promise\

Apply a PUT to the generated route

Params:

• putOptions?: Object
  • body?: Object or String - Data to send in the put
  • query?: Object or String - Properties passed in the object are added in the query.
  • headers?: Object - Extra headers can be added and override the default ones.

Returns: A Promise with the information in a JSON received from the API. In case of an error receives an Object with error information.

delete(deleteOptions?): Promise\

Apply a DELETE to the generated route

Params:

• deleteOptions?: Object
  • body?: Object or String - Data to send in the delete
  • query?: Object or String - Properties passed in the object are added in the query.
  • headers?: Object - Extra headers can be added and override the default ones.

Returns: A Promise with the information in a JSON received from the API. In case of an error receives an Object with error information.