discord.js README

The project's README from github.com/discordjs/discord.js. As one markdown file: README.md.


discord.js


Discord server npm version npm downloads Tests status Last commit. contributors backers Code coverage

Vercel Cloudflare Workers

About

This repository contains multiple packages with separate releases. You can find the assembled Discord API wrapper at discord.js. It is a powerful Node.js module that allows you to easily interact with the Discord API.

Packages

Containers

Contributing

Please read through our contribution guidelines before starting a pull request. We welcome contributions of all kinds, not just code! If you're stuck for ideas, look for the good first issue label on issues in the repository. If you have any questions about the project, feel free to ask them on Discord. Before creating your own issue or pull request, always check to see if one already exists! Don't rush contributions, take your time and ensure you're doing it correctly.

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 join our Discord server.

discord.js (discordjs/discord.js)

Searching Database…

Что это такое?discord.js — это мощный модуль для Node.js для работы с Discord API, фактически основная библиотека на JavaScript/TypeScript для написания ботов для Discord. В этом репозитории лежит сама библиотека и её вспомогательные пакеты.
Это одна библиотека или много отдельных пакетов?Это монорепозиторий: собранная обёртка discord.js плюс около десятка вспомогательных пакетов с префиксом @discordjs, каждый версионируется и выпускается отдельно, поэтому проект может зависеть только от нужных ему частей.
Как начать делать бота с её помощью?Установите пакет discord.js из npm в проект на Node.js и следуйте официальному руководству, либо запустите create-discord-bot — утилиту командной строки, которая создаёт готовый проект бота.
Что должно быть установлено, чтобы она заработала?Свежая версия Node.js — репозиторию нужна версия 24.17.0 или новее. Больше ничего не требуется: это обычная npm-зависимость, ничего дополнительно настраивать не нужно.
Переход между мажорными версиями проходит безболезненно?Мажорные обновления требуют работы по миграции: есть отдельное руководство по переходу с v13 на v14 со списком изменённых и удалённых пунктов, так что обновление между мажорными версиями — это не простая замена номера версии.
Сможет ли бот на ней заходить в голосовые каналы?Да — голосовая поддержка относится к базовым возможностям: @discordjs/voice — отдельный модуль для работы с Discord Voice API, а voice-support входит в число тем проекта.
Можно использовать её части вместо полноценной высокоуровневой библиотеки?Да — @discordjs/core это тонкая обёртка над базовыми компонентами API, @discordjs/rest общается с REST API напрямую, а @discordjs/ws оборачивает только шлюз (gateway). @discordjs/builders помогает собирать payload'ы для API.
Зачем запускать HTTP-прокси вместо прямых обращений к API?Когда запросы должны идти через посредника: @discordjs/proxy оборачивает @discordjs/rest и поднимает HTTP-прокси для Discord API, а в репозитории он распространяется в виде готового контейнера discordjs/proxy.
Она хорошо подходит для проектов на TypeScript?Да — сам код библиотеки написан на TypeScript, так что описания типов идут из коробки.
Creator
discordjs
Size
66.9 MB
Stars
26.8K
Age
11y
Commits · 90 Days