Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

davipatricio/discord-api-types-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github tag CodeFactor DeepSource made-with-Go GitHub go.mod Go version of a Go module

discord-api-types-go

Up to date Discord API Typings for Golang. Inspired by discordjs/discord-api-types

Installation

Stable version:

go get -u github.com/denkylabs/discord-api-types-go

Development version:

$ cd $GOPATH
$ mkdir -p src/github.com/denkylabs
$ cd src/github.com/denkylabs
$ git clone https://github.com/denkylabs/discord-api-types-go.git
$ cd discord-api-types-go
$ go install

Project Structure

The exports of each package is split into three main parts:

  • Everything exported with the API prefix represents a payload you may get from the REST API or the Gateway.

  • Everything exported with the Gateway prefix represents data that ONLY comes from or is directly related to the Gateway.

  • Everything exported with the REST prefix represents data that ONLY comes from or is directly related to the REST API.

  • Anything else that is miscellaneous will be exported based on what it represents (for example the REST route object or the Locale type and its constants).

Warning: This package documents just KNOWN (and documented) properties. Anything that isn't documented will NOT be added to this package (unless said properties are in an open Pull Request to Discord's API Documentation repository or known through other means and have received the green light to be used). For clarification's sake, this means that properties that are only known through the process of data mining and have not yet been confirmed in a way as described will NOT be included.

Useful links

Compatibility

Go version Status
Go 1.18 Tests status
Go 1.17 Not supported.
Go 1.16 Not supported.

This project is licensed under the MIT license.