Skip to content
This repository has been archived by the owner on Dec 18, 2021. It is now read-only.
/ SnowTransfer Public archive
forked from DasWolke/SnowTransfer

Minimalistic rest client for the discord api

License

Notifications You must be signed in to change notification settings

Vexera/SnowTransfer

 
 

Repository files navigation

We have switched back to the upstream version which now supports API v9. This repository is now archived and shouldn't be used anymore.

Thanks a lot @PapiOphidian for this big update :)

--

SnowTransfer

A minimalistic rest client for the discord api


GitHub stars Travis npm npm

Part of the WeatherStack

SnowTransfer is a small library specially made to only cover the REST/HTTP area of the discord api. It makes no assumptions about the rest of your stack, therefore you can use it anywhere as long as you use node 8 or higher.

Some of the things that make SnowTransfer awesome:

  • No requirement for other components
  • Full coverage of the discord rest api
  • Well documented
  • Sentry integration

General Usecase:

SnowTransfer is not your everyday library, especially compared to other libraries, it makes sense to use it when you:

  • Want to build a microservice based bot, where casual discord libraries would not be suitable since they assume the availability of other components like a gateway or a cache
  • Only need a simple rest client that can be wrapped easily.

Microservice Bots:

I've written a general whitepaper on the idea of microservice bots, which you can find on gist: Microservice Bot Whitepaper

Documentation:

You can find the docs at https://daswolke.github.io/SnowTransfer/

Installation:

To install SnowTransfer, make sure that you have node 8 or higher and npm installed on your computer.

Then run the following command in a terminal npm install snowtransfer

Example:

let SnowTransfer = require('snowtransfer');
let client = new SnowTransfer('DISCORD BOT TOKEN');
let request = async () => {
    let message = await client.channel.createMessage('channel id', 'hi there');
    console.log(message);
};
request().then(() => {
    // message was sent to discord
}).catch(e => {
    // an error occurred
});

About

Minimalistic rest client for the discord api

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%