26.8K ·GitHub
What is this?
discord.js is a powerful Node.js module for interacting with the Discord API — effectively the main JavaScript/TypeScript library for writing Discord bots. This repo hosts it and its helper packages.
discord.js is a powerful Node.js module for interacting with the Discord API — effectively the main JavaScript/TypeScript library for writing Discord bots. This repo hosts it and its helper packages.Is it one library or a bunch of separate packages?It's a monorepo: the assembled discord.js wrapper plus about a dozen @discordjs-scoped helper packages, each versioned and released separately, so a project can depend on just the pieces it needs.
It's a monorepo: the assembled discord.js wrapper plus about a dozen @discordjs-scoped helper packages, each versioned and released separately, so a project can depend on just the pieces it needs.How do I start building a bot with it?Install the discord.js package from npm into a Node.js project and follow the official guide, or run create-discord-bot — a CLI tool that scaffolds a ready bot project.
Install the discord.js package from npm into a Node.js project and follow the official guide, or run create-discord-bot — a CLI tool that scaffolds a ready bot project.What do I need installed before it will run?A recent Node.js — the repo requires version 24.17.0 or newer. Beyond that it's a plain npm dependency; nothing extra to set up.
A recent Node.js — the repo requires version 24.17.0 or newer. Beyond that it's a plain npm dependency; nothing extra to set up.Are upgrades between major versions painless?Major upgrades need migration work: there is a dedicated v13-to-v14 update guide listing updated and removed items, so version bumps between majors are not drop-in.
Major upgrades need migration work: there is a dedicated v13-to-v14 update guide listing updated and removed items, so version bumps between majors are not drop-in.Can a bot built with it join voice channels?Yes — voice is a first-class feature: @discordjs/voice is a dedicated module for interacting with the Discord Voice API, and voice-support is one of the project's listed topics.
Yes — voice is a first-class feature: @discordjs/voice is a dedicated module for interacting with the Discord Voice API, and voice-support is one of the project's listed topics.Can I use parts of it instead of the full high-level library?Yes — @discordjs/core is a thinly abstracted wrapper around the API's core components, @discordjs/rest talks to the REST API directly, and @discordjs/ws wraps just the gateway. @discordjs/builders helps assemble API payloads.
Yes — @discordjs/core is a thinly abstracted wrapper around the API's core components, @discordjs/rest talks to the REST API directly, and @discordjs/ws wraps just the gateway. @discordjs/builders helps assemble API payloads.Why would I run the HTTP proxy instead of calling the API directly?When requests should flow through an intermediary: @discordjs/proxy wraps @discordjs/rest to run an HTTP proxy for the Discord API, and the repo ships it as a ready-made discordjs/proxy container.
When requests should flow through an intermediary: @discordjs/proxy wraps @discordjs/rest to run an HTTP proxy for the Discord API, and the repo ships it as a ready-made discordjs/proxy container.Is it a good fit for TypeScript projects?Yes — the codebase itself is written in TypeScript, so type definitions come along out of the box.
Yes — the codebase itself is written in TypeScript, so type definitions come along out of the box.What are similar projects?discord.py, raft-source, openai-node, web3.js, whatsapp-web.js, iii, TitanBot, forge
discord.py, raft-source, openai-node, web3.js, whatsapp-web.js, iii, TitanBot, forge