mirror of
https://github.com/stoatchat/javascript-client-sdk.git
synced 2026-07-19 17:13:31 -04:00
Paul Makles
77 lines
1.7 KiB
Markdown
77 lines
1.7 KiB
Markdown
# revolt.js
|
|
|
|
 
|
|
|
|
**revolt.js** is a direct implementation of the entire Revolt API and provides a way to authenticate and start communicating with Revolt servers. **This is an ESM library!**
|
|
|
|
## Example Usage (Javascript / ES6)
|
|
|
|
```javascript
|
|
import { Client } from "revolt.js";
|
|
|
|
let client = new Client();
|
|
|
|
client.on("ready", async () =>
|
|
console.info(`Logged in as ${client.user.username}!`),
|
|
);
|
|
|
|
client.on("message", async (message) => {
|
|
if (message.content === "hello") {
|
|
message.channel.sendMessage("world");
|
|
}
|
|
});
|
|
|
|
client.loginBot("..");
|
|
```
|
|
|
|
If you are using Node, you must specify `--experimental-specifier-resolution=node`.
|
|
|
|
For example, `node --experimental-specifier-resolution=node index.js`.
|
|
|
|
## Example Usage (Typescript)
|
|
|
|
```typescript
|
|
import { Client } from "revolt.js";
|
|
|
|
let client = new Client();
|
|
|
|
client.on("ready", async () =>
|
|
console.info(`Logged in as ${client.user!.username}!`),
|
|
);
|
|
|
|
client.on("message", async (message) => {
|
|
if (message.content === "hello") {
|
|
message.channel!.sendMessage("world");
|
|
}
|
|
});
|
|
|
|
client.loginBot("..");
|
|
```
|
|
|
|
## MobX
|
|
|
|
MobX is used behind the scenes so you can subscribe to any change as you normally would, e.g. with `mobx-react(-lite)` or mobx's utility functions.
|
|
|
|
```typescript
|
|
import { autorun } from 'mobx';
|
|
|
|
[..]
|
|
|
|
client.once('ready', () => {
|
|
autorun(() => {
|
|
console.log(`Current username is ${client.user!.username}!`);
|
|
});
|
|
});
|
|
```
|
|
|
|
## Revolt API Types
|
|
|
|
All `revolt-api` types are re-exported from this library under `API`.
|
|
|
|
```typescript
|
|
import { API } from 'revolt.js';
|
|
|
|
// API.Channel;
|
|
// API.[..];
|
|
```
|