mirror of
https://github.com/stoatchat/javascript-client-sdk.git
synced 2026-07-21 04:25:27 -04:00
Paul Makles
63 lines
1.6 KiB
Markdown
63 lines
1.6 KiB
Markdown
# revolt.js
|
|
|
|
> **Warning**
|
|
> revolt.js is currently being rewritten, it's pretty much ready for use for most applications but is still not entirely feature complete.
|
|
>
|
|
> You can find the [version 6 README here](https://github.com/revoltchat/revolt.js/tree/v6).
|
|
|
|
 
|
|
|
|
**revolt.js** is a JavaScript library for interacting with the entire Revolt API.
|
|
|
|
## Example Usage
|
|
|
|
```javascript
|
|
// esm / typescript
|
|
import { Client } from "revolt.js";
|
|
// ...or commonjs
|
|
const { Client } = require("revolt.js");
|
|
|
|
let client = new Client();
|
|
|
|
client.on("ready", async () =>
|
|
console.info(`Logged in as ${client.user.username}!`)
|
|
);
|
|
|
|
client.on("messageCreate", async (message) => {
|
|
if (message.content === "hello") {
|
|
message.channel.sendMessage("world");
|
|
}
|
|
});
|
|
|
|
client.loginBot("..");
|
|
```
|
|
|
|
## Reactivity with Signals & Solid.js Primitives
|
|
|
|
All objects have reactivity built-in and can be dropped straight into any Solid.js project.
|
|
|
|
```tsx
|
|
const client = new Client();
|
|
// initialise the client
|
|
|
|
function MyApp() {
|
|
return (
|
|
<h1>Your username is: {client.user?.username ?? "[logging in...]"}</h1>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Revolt API Types
|
|
|
|
All `revolt-api` types are re-exported from this library under `API`.
|
|
|
|
> **Warning**
|
|
> It is advised you do not use this unless necessary, if you find somewhere that isn't covered by the library, please open an issue as this library aims to transform all objects.
|
|
|
|
```typescript
|
|
import { API } from "revolt.js";
|
|
|
|
// API.Channel;
|
|
// API.[..];
|
|
```
|