@sern/poster
TypeScript icon, indicating that this package has built-in type declarations

1.2.6 • Public • Published

Poster

REST API client for managing discord application commands.

features

  • Optionally typed responses
    • view an example here
  • Typed options
  • Simple! (sort of)
  • ClojureScript + Typescript
    • I'm sorry.

usage

import poster from '@sern/poster';

const send = await poster.client("token", "appid");

const req = await send("global/get-all", { 
    //options
});

console.log(await req.json());

Mappings

This package is pretty simple. Create a new client and call one of the "endpoints"

Endpoint Method Path
global/get-all GET /applications/{application.id}/commands
global/get GET /applications/{application.id}/commands/{command.id}
global/post POST /applications/{application.id}/commands
global/edit PATCH /applications/{application.id}/commands/{command.id}
global/delete DELETE /applications/{application.id}/commands/{command.id}
global/put PUT /applications/{application.id}/commands
guild/get-all GET /applications/{application.id}/guilds/{guild.id}/commands
guild/post POST /applications/{application.id}/guilds/{guild.id}/commands
guild/get GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
guild/edit PATCH /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
guild/delete DELETE /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
guild/put PUT /applications/{application.id}/guilds/{guild.id}/commands
application/me GET /applications/@me

Documentation for these routes are specified in the discord api documentation, starting here.

Extra

For fully typed responses (which i do not recommend), cast your response. An example exists here. Also I don't know if they work for every single type, if they dont, I will fix it if it is a serious issue.

Developing

git clone https://github.com/sern-handler/tools.git
cd tools
yarn
cd packages/poster
yarn run gen-discord-types
yarn build:debug

Readme

Keywords

none

Package Sidebar

Install

npm i @sern/poster

Weekly Downloads

4

Version

1.2.6

License

ISC

Unpacked Size

534 kB

Total Files

10

Last publish

Collaborators

  • evolutionx-10
  • jacoobes
  • xxdeveloper