0.0.6 • Published 2 years ago
@arthur.dev/discord-oauth2 v0.0.6
discord-oauth2
A simple NPM package to interact with the discord OAuth2 API
Examples
Installation
With NPM:
npm install @arthur.dev/discord-oauth2
or with Yarn:
yarn add @arthur.dev/discord-oauth2
Usage
import DiscordOAuth from '@arthur.dev/discord-oauth2';
or
const DiscordOAuth = require("@arthur.dev/discord-oauth2");
const oauth = new DiscordOAuth({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
callbackUrl: "http://localhost:8080/callback",
scope: ["identify", "guilds", "connections"]
});
- Exchange code for Discord Access Token
const { access_token } = await oauth.exchangeCode(code);
- Exchange refresh token for a new Discord Access Token
const { access_token } = await oauth.exchangeRefreshToken(refresh_token);
- Fetch user
const user = await oauth.fetchUser(access_token)
- Get user guilds and connections
const guilds = await user.guilds();
const connections = await user.connections();
console.log(guilds);
console.log(connections);
Contributing
When contributing please ensure you use NPM as your package manager.
Building
npm install
to install dependenciesnpm run build
to build the module
Development & Testing
When contributing it is recommended to test your changes to do this you could use the Express example. Or you could create a new example, though if you would like the push these changes please do so in a seperate pull request.
Coding Conventions
- Use 4 space indentation
- Use camelCase for function names and class members
- UPPER_CASE for constant variables defined in
src/constants.ts
Commit Conventions