https://github.com/revoltchat/api

Typescript typings and OpenAPI v3 generator for the Revolt API.
https://github.com/revoltchat/api

api openapi revolt typescript

Last synced: about 19 hours ago
JSON representation

Typescript typings and OpenAPI v3 generator for the Revolt API.

• Host: GitHub
• URL: https://github.com/revoltchat/api
• Owner: revoltchat
• License: mit
• Created: 2021-09-04T11:13:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-28T00:43:58.000Z (about 1 month ago)
• Last Synced: 2025-01-19T17:05:59.457Z (8 days ago)
• Topics: api, openapi, revolt, typescript
• Language: TypeScript
• Homepage: https://developers.revolt.chat/api/
• Size: 522 KB
• Stars: 36
• Watchers: 1
• Forks: 26
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Revolt API

![revolt-api](https://img.shields.io/npm/v/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).