stoatchat/javascript-client-sdk
1
0
Fork 0
mirror of https://github.com/stoatchat/javascript-client-sdk.git synced 2026-07-18 16:34:27 -04:00
Code Issues 9 Packages Projects Releases 6 Wiki Activity

chore: update README

Browse Source
This commit is contained in:
Paul Makles
2023-04-14 20:04:38 +01:00
parent 4490ead0b6
commit fd6bf3e25f
1 changed files with 28 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -62
View File
@@ -1,95 +1,61 @@
# 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](https://img.shields.io/npm/v/revolt.js) ![revolt-api](https://img.shields.io/npm/v/revolt-api?label=Revolt%20API)
**revolt.js** is a direct implementation of the entire Revolt API and provides a way to authenticate and start communicating with Revolt servers.
**revolt.js** is a JavaScript library for interacting with the entire Revolt API.
## Example Usage (Javascript / ES6)
## Example Usage
```javascript
// esm / 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("..");
```
If you are using Node, you must specify `--experimental-specifier-resolution=node`.
For example, `node --experimental-specifier-resolution=node index.js`.
## Example Usage (CommonJS)
```javascript
// ...or commonjs
const { Client } = require("revolt.js");
let client = new Client();
client.on("ready", async () =>
console.info(`Logged in as ${client.user.username}!`),
console.info(`Logged in as ${client.user.username}!`)
);
client.on("message", async (message) => {
if (message.content === "hello") {
message.channel.sendMessage("world");
}
client.on("messageCreate", async (message) => {
if (message.content === "hello") {
message.channel.sendMessage("world");
}
});
client.loginBot("..");
```
## Example Usage (Typescript)
## Reactivity with Signals & Solid.js Primitives
```typescript
import { Client } from "revolt.js";
All objects have reactivity built-in and can be dropped straight into any Solid.js project.
let client = new Client();
```tsx
const client = new Client();
// initialise the 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}!`);
});
});
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';
import { API } from "revolt.js";
// API.Channel;
// API.[..];