Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@notenoughupdates/discord-api-types
Advanced tools
Readme
Simple type definitions for the Discord API.
Install with npm / yarn / pnpm:
npm install discord-api-types
yarn add discord-api-types
pnpm add discord-api-types
You can only import this module by specifying the API version you want to target. Append /v*
to the import path, where the *
represents the API version. Below are some examples
const { APIUser } = require('discord-api-types/v9');
// TypeScript/ES Module support
import { APIUser } from 'discord-api-types/v9';
You may also import just certain parts of the module that you need. The possible values are: globals
, gateway
, gateway/v*
, payloads
, payloads/v*
, rest
, rest/v*
, rpc
, rpc/v*
, utils
, utils/v*
, voice
, and voice/v*
. Below are some examples
const { GatewayVersion } = require('discord-api-types/gateway/v9');
// TypeScript/ES Module support
import { GatewayVersion } from 'discord-api-types/gateway/v9';
Note: The
v*
exports (discord-api-type/v*
) include the appropriate version ofgateway
,payloads
,rest
,rpc
, andutils
you specified, alongside theglobals
exports
We also provide typings compatible with the deno runtime. You have 3 ways you can import them:
// Importing a specific API version
import { APIUser } from 'https://raw.githubusercontent.com/discordjs/discord-api-types/main/deno/v9.ts';
// Importing a specific API version
import { APIUser } from 'https://deno.land/x/discord_api_types/v9.ts';
// Importing a specific API version
import { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v9?dts';
The exports of each API version 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.
For endpoint options, they will follow the following structure: REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>
where the type represents what it will return.
For example, RESTPostAPIChannelMessageJSONBody
or RESTGetAPIGatewayBotInfoResult
.
Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either RESTOAuth2
or with something similar to REST<HTTP Method>OAuth2
If a type ends with Result
, then it represents the expected result by calling its accompanying route.
never
usually mean the result will be a 204 No Content
, so you can safely ignore it. This does not account for errors.Anything else that is miscellaneous will be exported based on what it represents (for example the REST
route object).
There may be types exported that are identical for all versions. These will be exported as is and can be found in the globals
file. They will still be prefixed accordingly as described above.
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.
FAQs
Discord API typings that are kept up to date for use in bot library creation.
The npm package @notenoughupdates/discord-api-types receives a total of 0 weekly downloads. As such, @notenoughupdates/discord-api-types popularity was classified as not popular.
We found that @notenoughupdates/discord-api-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.