Skip to content

Repository files navigation

Revolt API

revolt-api

This package contains typings for objects in the Revolt API and a fully typed API request builder.

Example Usage

If you just need access to types:

importtype{User}from'revolt-api';

If you want to send requests:

import{API}from'revolt-api';// Initialise a new API client:constclient=newAPI();// or with authentication:constclient=newAPI({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:letchannel_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.

About

Typescript typings and OpenAPI v3 generator for the Stoat API.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

42 stars

Watchers

1 watching

Forks

Contributors

Languages