Create a discord bot with TypeScript and Decorators!

Introduction

This module is an extension of discord.js, so the internal behavior (methods, properties, ...) is the same.

This library allows you to use TypeScript decorators on discord.js, it simplify your code and improve the readability !

Requirements

Name	Version
Node.js	>= 16.6.0
TypeScript	>= 4.4.4

Easy setup - starter project

1. Setup new project

npx create-discordx

2. Build

npm

npm run build

Yarn

yarn build

3. Setup bot token

Windows

// cmd
set BOT_TOKEN=REPLACE_THIS_WITH_YOUR_BOT_TOKEN

// powershell
$ENV:BOT_TOKEN="REPLACE_THIS_WITH_YOUR_BOT_TOKEN"

Linux

export BOT_TOKEN=REPLACE_THIS_WITH_YOUR_BOT_TOKEN

4. Run

npm

npm run start

Yarn

yarn start

5. And you're done, everything has been done for you! 🚀

Installation

Stable

Use npm or yarn to install discordx with discord.js

npm

npm install discordx discord.js

Yarn

yarn add discordx discord.js

Install your TypeScript dev dependencies too

npm

npm install --save-dev @types/node typescript

Yarn

yarn add --dev @types/node typescript

And you should see this in your package.json

package.json

{
  // ...
  "dependencies": {
    "discordx": "^X.X.X",
    "discord.js": "^X.X.X"
  },
  "devDependencies": {
    "@types/node": "^X.X.X",
    "typescript": "^X.X.X"
  }
  // ...
}

If you need to update again in the future just run:

npm

npm install discordx discord.js

Yarn

yarn add discordx discord.js

Development

Use npm or yarn to install discordx with discord.js

npm

npm install discordx@dev discord.js@dev

Yarn

yarn add discordx@dev discord.js@dev

Install your TypeScript dev dependencies too

npm

npm install --save-dev @types/node typescript

Yarn

yarn add --dev @types/node typescript

And you should see this in your package.json

package.json

{
  // ...
  "dependencies": {
    "discordx": "^X.X.X-dev.###",
    "discord.js": "^X.X.X-dev.###.###"
  },
  "devDependencies": {
    "@types/node": "^X.X.X",
    "typescript": "^X.X.X"
  }
  // ...
}

If you need to update again in the future just run:

npm

npm install discordx@dev discord.js@dev

Yarn

yarn add discordx@dev discord.js@dev

Execution environment

To start your bot you can compile your code into JavaScript with TypeScript using the tsc command or simple use ts-node.

caution

You must specify the .js files when you initialize your client if you compile your code into JavaScript with tsc

const client = new Client({
  intents: [
    IntentsBitField.Flags.Guilds,
    IntentsBitField.Flags.GuildMessages,
    IntentsBitField.Flags.GuildMembers,
  ],
  silent: false,
});

client.on("ready", async () => {
  console.log(">> Bot started");

  // to create/update/delete discord application commands
  await client.initApplicationCommands();
});

client.login(BOT_TOKEN);

:::

tsconfig.json

Your tsconfig.json file should look like this:

ECMAScript

package.json

{
  ...
  "type": "module",
  ...
}

tsconfig.json

{
  "compilerOptions": {
    "module": "ESNext", // required
    "target": "ESNext", // required
    "noImplicitAny": true,
    "sourceMap": true,
    "strict": true,
    "outDir": "build",
    "emitDecoratorMetadata": false, // required
    "experimentalDecorators": true, // required
    "declaration": false,
    "importHelpers": true, // required
    "forceConsistentCasingInFileNames": true,
    "moduleResolution": "Node", // required
    "esModuleInterop": true // required
  },
  "exclude": ["node_modules"]
}

CommonJs

package.json

{
  ...
  "type": "commonjs",
  ...
}

tsconfig.json

{
  "compilerOptions": {
    "module": "CommonJS", // required
    "target": "ESNext", // required
    "noImplicitAny": true,
    "sourceMap": true,
    "strict": true,
    "outDir": "build",
    "emitDecoratorMetadata": false, // required
    "experimentalDecorators": true, // required
    "declaration": false,
    "importHelpers": true, // required
    "forceConsistentCasingInFileNames": true,
    "moduleResolution": "Node", // required
    "esModuleInterop": true // required
  },
  "exclude": ["node_modules"]
}

Need help?

discord server

You can also find help with examples folder

See also

• discord.js's documentation
• Discord's application command interactions

Next step

Setup and start your application 🚀