mirror of
https://github.com/stoatchat/javascript-client-api.git
synced 2026-07-19 09:04:36 -04:00
Paul Makles
40 lines
1003 B
Markdown
40 lines
1003 B
Markdown
# Revolt API
|
|
|
|
|
|
|
|
This package contains typings for objects in the [Revolt API](https://developers.revolt.chat/api/) and a fully typed API request builder.
|
|
|
|
### Example Usage
|
|
|
|
If you just need access to types:
|
|
|
|
```typescript
|
|
import type { User } from 'revolt-api';
|
|
```
|
|
|
|
If you want to send requests:
|
|
|
|
```typescript
|
|
import { API } from 'revolt-api';
|
|
|
|
// Initialise a new API client:
|
|
const client = new API();
|
|
|
|
// or with authentication:
|
|
const client = new API({ authentication: { revolt: 'bot-token' } });
|
|
|
|
// Make requests with ease:
|
|
client.get('/users/@me')
|
|
// Fully typed responses!
|
|
.then(user => user.username);
|
|
|
|
// No need to worry about the details:
|
|
let channel_id = "some channel id";
|
|
client.post(`/channels/${channel_id}/messages`, {
|
|
// Parameters given are fully typed as well!
|
|
content: "some content"
|
|
});
|
|
```
|
|
|
|
For more details on how this works, see the [README of @insertish/oapi](https://github.com/insertish/oapi#example).
|