https://github.com/upryzing/upryzing.js
TypeScript library for interacting with Upryzing
https://github.com/upryzing/upryzing.js
Last synced: over 1 year ago
JSON representation
TypeScript library for interacting with Upryzing
- Host: GitHub
- URL: https://github.com/upryzing/upryzing.js
- Owner: upryzing
- License: mit
- Created: 2024-12-17T03:06:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-23T04:09:33.000Z (over 1 year ago)
- Last Synced: 2025-03-23T04:25:54.645Z (over 1 year ago)
- Language: TypeScript
- Size: 2.07 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# upryzing.js
 
**upryzing.js** is a JavaScript library for interacting with the entire Revolt API.
## Example Usage
```javascript
// esm / typescript
import { Client } from "@upryzing/upryzing.js";
// ...or commonjs
const { Client } = require("upryzing/upryzing.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 (
Your username is: {client.user?.username ?? "[logging in...]"}
);
}
```
## Upryzing API Types
> [!WARNING]
> It is advised that you **do not use this** unless necessary. If you find something that isn't covered by the library, please open an issue as this library aims to transform all objects.
All `@uprzying/api` types are re-exported from this library under the `API` object.
```typescript
import { API } from "@upryzing/upryzing.js";
// API.Channel;
// API.[..];
```