2.5.0 • Published 4 months ago

@discordjs/rest v2.5.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 months ago

About

@discordjs/rest is a module that allows you to easily make REST requests to the Discord API.

Installation

Node.js 16.11.0 or newer is required.

Note: native fetch (not recommended) is unavailable in this node version, either use a newer node version or use the more performant undiciRequest strategy (default)

npm install @discordjs/rest
yarn add @discordjs/rest
pnpm add @discordjs/rest
bun add @discordjs/rest

Examples

Install all required dependencies:

npm install @discordjs/rest discord-api-types
yarn add @discordjs/rest discord-api-types
pnpm add @discordjs/rest discord-api-types
bun add @discordjs/rest discord-api-types

Send a basic message:

import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10' }).setToken(TOKEN);

try {
	await rest.post(Routes.channelMessages(CHANNEL_ID), {
		body: {
			content: 'A message via REST!',
		},
	});
} catch (error) {
	console.error(error);
}

Create a thread from an existing message to be archived after 60 minutes of inactivity:

import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10' }).setToken(TOKEN);

try {
	await rest.post(Routes.threads(CHANNEL_ID, MESSAGE_ID), {
		body: {
			name: 'Thread',
			auto_archive_duration: 60,
		},
	});
} catch (error) {
	console.error(error);
}

Send a basic message in an edge environment:

import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v10';

const rest = new REST({ version: '10', makeRequest: fetch }).setToken(TOKEN);

try {
	await rest.post(Routes.channelMessages(CHANNEL_ID), {
		body: {
			content: 'A message via REST from the edge!',
		},
	});
} catch (error) {
	console.error(error);
}

Links

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.
See the contribution guide if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official discord.js Server.

discord.js@pixelpizza/librarysecretclientdjs-snow@claudiozh/bot-discord-zh@claudiozh/bot-discord-zh-123nodejs-custom-version@claudiozh/bot-discorddiscord.js-slash-handlerpara.jsdaydreamcmdstwilight-toolkitnotcord.jsextended-clientdisdai.jsdiscordjs-novawavejs_builderseasy-canvas-discorddiscord.js-slashcmd-handler@hammerhq/client@hammerhq/commandstraumateamdbotczudisk-bot@e9x/discord.js-selfbot@elias.schaut/discord-bot-template@infinitebrahmanuniverse/nolb-_dis@keunheekwon/atbot@limitlesspc/limitlessrexom.jsdiscord-emojiquiztmc-djs-utiltoowakediscord-jax@everything-registry/sub-chunk-245alemon-botdiscord-botlynairol-handlernordlibaltyapi-v13syriswinston-transport-discordsparty18-clivespera@buzzybot/injex-discord-plugin@blackprint/nodes-discordjardbfiubusjadljkt48connect-discordjs-discordjshaikujuliokriger-winston-transport-discordifa.jsinfinite-clientharmonic-strawberryhesperushellyhennus-apihandler-managerhandlercordhandlercord-tbinteractions.jsinteractions.tslink-flayerload-slash-commandslewismccafferymasatsu.tslebotdulovekooterdiscordstructuresmaverick-opcommands@xenfo/snow.js@wozardlozard/discord.js@therealbenpai/djs-client@typicalbot/commands@unh-csonline/discord-modules@themetakey/discord-bot@voiddevs.org/slashbot@urban-bot/discord@xhayper/discord-rpc@yor/core@yuudachi/framework@zerrodevs/discord-bot-utilsa-djs-handleraxo.jsaurionbotawesomesciboastra-lite.js@claudiozh/bot-discordjs@a-djs-handler/framework@airdot/linked-roles@ai16z/client-discord@easybotjs/core@eazyautodelete/core@eazyautodelete/eazyautodelete-core@conflict/beta@conductr/core@alishd/discord-node-bot-boilerplate@almostjohn/djs-framework@almostjohn/scaffold.js@collabland/discord
2.5.0

6 months ago

2.4.1

10 months ago

2.4.3

8 months ago

2.4.2

10 months ago

2.4.0

1 year ago

2.3.0

1 year ago

2.1.0

2 years ago

2.2.0

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

1.7.1

2 years ago

1.7.0

3 years ago

1.6.0

3 years ago

1.5.0

3 years ago

1.4.0

3 years ago

1.3.0

3 years ago

1.2.0

3 years ago

1.1.0

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.6.0

3 years ago

0.5.0

3 years ago

0.4.1

4 years ago

0.4.0

4 years ago

0.3.0

4 years ago

0.2.0-canary.0

4 years ago

0.1.1-canary.0

4 years ago

0.1.0-canary.0

4 years ago