Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add discord-api-types as a community resource #2401

Merged
merged 2 commits into from
Apr 6, 2021

Conversation

vladfrangu
Copy link
Contributor

discord-api-types is a TypeScript/JavaScript (enums work in JS, and types can be used in JSDocs via @type {import('discord-api-types/v8).APIUser} as an example) module I created that keeps an up-to-date* representation of Discord's current API, that users can use either in library making, or casually if they ever need to do raw API calls. We are keeping this module up to date, and versioning it by the API version provided by Discord.

The main message might need some improvement, so please suggest if you have any! 😅
(also, are the names.. Discord names, GitHub names? Which one is it 👀 )

*: Per our readme, we only document types that have received some form of greenlight to be used, so it may be outdated at times

In the future, we might look into a way to turn the TS types into accurate typings in different languages (say, C#, Rust, Go, etc), which users can then use, should they choose to

@apacheli
Copy link
Contributor

It'd be nice if this was compatible with the Deno environment.

@vladfrangu
Copy link
Contributor Author

It'd be nice if this was compatible with the Deno environment.

Deno support is something I'd love to have, however, as I do not use Deno, I don't know what would be required to add support for it :(

If you have any ideas, or want to help out, you can either DM me on Discord (Vladdy#0002) or even submit a PR 👍

@vladfrangu
Copy link
Contributor Author

It'd be nice if this was compatible with the Deno environment.

@apacheli as of 0.12.0, it is now deno compatible 😋! Check the readme on the GitHub for more information on how to use it 👀

@night night merged commit 0780a47 into discord:master Apr 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants