# discord-nestjs-xzyv > NestJS package for discord.js Latest version **1.0.5** (published 2020-12-07) · MIT license · 0 weekly downloads ## Install ```sh npm install discord-nestjs-xzyv pnpm add discord-nestjs-xzyv yarn add discord-nestjs-xzyv bun add discord-nestjs-xzyv ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.5 | | Published | 2020-12-07 | | First published | 2020-12-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 59.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | xzy | | Maintainers | xzy1102358252 | | Keywords | nestjs, discord, decorator, bot, nest, typescript | ## Links - npm: https://www.npmjs.com/package/discord-nestjs-xzyv - npm.io page: https://npm.io/package/discord-nestjs-xzyv ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 1.0.5 (latest) — 2020-12-07 - 1.0.4 — 2020-12-07 - 1.0.3 — 2020-12-07 - 1.0.2 — 2020-12-07 - 1.0.1 — 2020-12-07 - 1.0.0 — 2020-12-05 - 0.2.8 — 2020-12-05 - 0.2.7 — 2020-12-05 - 0.2.6 — 2020-12-05 - 0.2.5 — 2020-12-05 - 0.2.4 — 2020-12-05 - 0.2.3 — 2020-12-05 - 0.2.2 — 2020-12-05 - 0.2.1 — 2020-12-05 - 0.2.0 — 2020-12-05 - … 6 more at https://npm.io/package/discord-nestjs-xzyv/versions ## README

Nest Logo

[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master [travis-url]: https://travis-ci.org/nestjs/nest [linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux [linux-url]: https://travis-ci.org/nestjs/nest

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

NPM Version Package License

## 🧾 Description NestJS package for discord.js ## 👨🏻‍💻 Installation ```bash $ npm install discord-nestjs discord.js ``` OR ```bash $ yarn add discord-nestjs discord.js ``` ## 📑 Overview You can use `forRoot` or `forRootAsync` to configure your module - `token` \* - your discord bot token [see](https://discord.com/developers/applications) - `commandPrefix` \* - global prefix for command events - `allowGuilds` - list of Guild IDs that the bot is allowed to work with - `denyGuilds` - list of Guild IDs that the bot is not allowed to work with - `allowChannels` - linking commands to a channel (can also be set through a decorator) - `commandName` \* - command name - `channels` \* - channel ID list - `webhook` - connecting with webhook - `webhookId` \* - webhook id - `webhookToken` \* - webhook token - you can also set all options as for the client from the "discord.js" library #### 💡 Example ```typescript /*bot.module.ts*/ @Module({ imports: [ DiscordModule.forRoot({ token: 'Njg2MzI2OTMwNTg4NTY1NTQx.XmVlww.EF_bMXRvYgMUCQhg_jYnieoBW-k', commandPrefix: '!', allowGuilds: ['745366351929016363'], denyGuilds: ['520622812742811698'], allowChannels: [ { commandName: 'some', channels: ['745366352386326572'], }, ], webhook: { webhookId: 'your_webhook_id', webhookToken: 'your_webhook_token', }, // and other discord options }), ], providers: [BotGateway], }) export class BotModule {} ``` Or async ```typescript /*bot.module.ts*/ @Module({ imports: [ DiscordModule.forRootAsync({ useFactory: () => ({ token: 'Njg2MzI2OTMwNTg4NTY1NTQx.XmVlww.EF_bMXRvYgMUCQhg_jYnieoBW-k', commandPrefix: '!', allowGuilds: ['745366351929016363'], denyGuilds: ['520622812742811698'], allowChannels: [ { commandName: 'some', channels: ['745366352386326572'], }, ], webhook: { webhookId: 'your_webhook_id', webhookToken: 'your_webhook_token', }, // and other discord options }), }), ], providers: [BotGateway], }) export class BotModule {} ``` ## ▶️ Usage Create your class (e.g. `BotGateway`), mark it with `@Injectable()` or `@Controller()` #### 💡 Example ```typescript /*bot.gateway.ts*/ import { Injectable, Logger } from '@nestjs/common'; import { On, DiscordClient } from 'discord-nestjs'; @Injectable() export class BotGateway { private readonly logger = new Logger(BotGateway.name); constructor(private readonly discordClient: DiscordClient) {} @On({ event: 'ready' }) onReady(): void { this.logger.log(`Logged in as ${this.discordClient.user.tag}!`); this.discordClient.getWebhookClient().send('hello bot is up!'); } } ``` ## ✨ You can use the following decorators: ### ℹ️ Decorator @Client You can get discord client via @Client() decorator instead constructor property #### 💡 Example ```typescript /*bot.gateway.ts*/ import { Injectable, Logger } from '@nestjs/common'; import { On, DiscordClient } from 'discord-nestjs'; @Injectable() export class BotGateway { private readonly logger = new Logger(BotGateway.name); @Client() discordClient: DiscordClient; @On({ event: 'ready' }) onReady(): void { this.logger.log(`Logged in as ${this.discordClient.user.tag}!`); } } ``` ### ℹ️ Decorator @Command Use the @Command decorator to handle incoming commands to the bot - `name` \* - command name - `prefix` - override global prefix - `isRemoveCommandName` - remove command name from message - `isRemovePrefix` - remove prefix name from message - `isIgnoreBotMessage` - ignore incoming messages from bots - `allowChannels` - list of channel identifiers on which this command will work - `isRemoveMessage` - remove message from channel after receive #### 💡 Example ```typescript /*bot.gateway.ts*/ @Injectable() export class BotGateway { @OnCommand({ name: 'start' }) async onCommand(message: Message): Promise { await message.reply(`Execute command: ${message.content}`); } } ``` ### ℹ️ Decorator @On Handle discord events [see](https://gist.github.com/koad/316b265a91d933fd1b62dddfcc3ff584) - `event` \* - name of the event to listen to #### 💡 Example ```typescript /*bot.gateway.ts*/ @Injectable() export class BotGateway { @On({ event: 'message' }) async onMessage(message: Message): Promise { if (!message.author.bot) { await message.reply("I'm watching you"); } } } ``` ### ℹ️ Decorator @Once Handle discord events (only once) [see](https://gist.github.com/koad/316b265a91d933fd1b62dddfcc3ff584) - `event` \* - name of the event to listen to #### 💡 Example ```typescript /*bot.gateway.ts*/ @Injectable() export class BotGateway { @Once({ event: 'message' }) async onceMessage(message: Message): Promise { if (!message.author.bot) { await message.reply("I'm watching you"); } } } ``` ### ℹ️ Decorator @UseGuards (Test feature) To guard incoming messages you can use `@UseGuards()` decorator #### 💡 Example You need to implement `DiscordGuard` interface ```typescript /*bot.guard.ts*/ import { DiscordGuard } from 'discord-nestjs'; import { ClientEvents, Message } from 'discord.js'; export class BotGuard implements DiscordGuard { async canActive( event: keyof ClientEvents, context: Message, ): Promise { if (context.author.id === '766863033789563648') { return true; } else { const embed = new MessageEmbed().setColor().setTitle('Ups! Not allowed!'); await context.reply(embed); return false; } } } ``` ```typescript /*bot.gateway.ts*/ import { On, UseGuards, OnCommand } from 'discord-nestjs'; import { Message } from 'discord.js'; @Injectable() export class BotGateway { @UseGuards(BotGuard) @OnCommand({ name: 'hide' }) async guardCommand(message: Message): Promise { // to do something } } ``` ### ℹ️ Decorator @UseInterceptors (Test feature) To intercept incoming messages you can use `@UseInterceptors()` decorator #### 💡 Example You need to implement `DiscordInterceptor` interface ```typescript /*bot.interceptor.ts*/ import { DiscordInterceptor } from 'discord-nestjs'; import { ClientEvents } from 'discord.js'; export class BotInterceptor implements DiscordInterceptor { intercept(event: keyof ClientEvents, context: any): any { return 'Some custom value'; } } ``` ```typescript /*bot.gateway.ts*/ import { On, UseInterceptors } from 'discord-nestjs'; @Injectable() export class BotGateway { @UseInterceptors(BotInterceptor) @On({ event: 'message' }) async onSomeEvent(context: string): Promise { // to do something } } ``` ### ℹ️ Decorator @Middleware (Test feature) For handling intermediate requests you can use `@Middleware` decorator - `allowEvents` - handled events - `denyEvents` - skipped events #### 💡 Example You need to implement `DiscordMiddleware` interface ```typescript /*bot.middleware.ts*/ @Middleware() export class BotMiddleware implements DiscordMiddleware { private readonly logger = new Logger(BotMiddleware.name); use( event: keyof ClientEvents, context: ClientEvents[keyof ClientEvents], ): void { if (event === 'message') { this.logger.log('On message event triggered'); } } } ``` Don't forget to add to providers ```typescript @Module({ providers: [BotMiddleware], }) export class BotModule {} ``` Any questions or suggestions? Discord Федок#3051 --- _Source: https://npm.io/package/discord-nestjs-xzyv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._