6.8.8 • Published 4 months ago

necord v6.8.8

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

About

This package uses the best of the Node.js world under the hood. Discord.js is the most powerful library for creating bots and Nest.js is a progressive framework for creating well-architectured applications. This module provides a fast and easy way of creating Discord bots and deep integration with your NestJS application.

Features

  • Simple. Flexible. Easy to use.
  • Ability to create custom decorators.
  • Interact with Discord (Slash Commands, Context Menus, Message Components, Listeners).
  • Full support of NestJS guards, interceptors, filters and pipes!

For questions and support, please use the Issues.

Installation

Node.js 18.0.0 or newer is required.

$ npm i necord discord.js
$ yarn add necord discord.js
$ pnpm add necord discord.js

Usage

Once the installation process is complete, we can import the NecordModule into the root AppModule:

import { NecordModule } from 'necord';
import { Module } from '@nestjs/common';
import { AppUpdate } from './app.update';

@Module({
    imports: [
        NecordModule.forRoot({
            token: 'DISCORD_BOT_TOKEN',
            intents: ['Guilds', 'GuildMessages', 'DirectMessages']
        })
    ],
    providers: [AppUpdate]
})
export class AppModule {
}

Then create app.update.ts file and add On/Once decorators for handling Discord API events:

import { Injectable, Logger } from '@nestjs/common';
import { Context, On, Once, ContextOf } from 'necord';
import { Client } from 'discord.js';

@Injectable()
export class AppUpdate {
    private readonly logger = new Logger(AppUpdate.name);

    public constructor(private readonly client: Client) {
    }
    
    @Once('ready')
    public onReady(@Context() [client]: ContextOf<'ready'>) {
        this.logger.log(`Bot logged in as ${client.user.username}`);
    }

    @On('warn')
    public onWarn(@Context() [message]: ContextOf<'warn'>) {
        this.logger.warn(message);
    }
}

Whenever you need to handle any event data, use the Context decorator.

If you want to fully dive into Necord, check out these resources:

  • Necord Wiki - Official documentation of Necord.
  • Nest JS - A progressive framework for creating well-architectured applications.
  • Discord JS - The most powerful library for creating bots.
  • Discord API - Official documentation of Discord API.

Backers

Stay in touch

License

MIT © Alexey Filippov

6.8.7

5 months ago

6.8.8

4 months ago

6.8.5

10 months ago

6.8.4

10 months ago

6.8.6

10 months ago

6.8.3

1 year ago

6.8.2

1 year ago

6.8.1

1 year ago

6.8.0

1 year ago

6.7.0

1 year ago

6.6.1

1 year ago

6.6.0

1 year ago

6.5.0

2 years ago

6.1.6

2 years ago

6.1.5

2 years ago

6.1.8

2 years ago

6.1.7

2 years ago

6.2.1

2 years ago

6.2.0

2 years ago

6.3.0

2 years ago

6.4.2

2 years ago

6.4.1

2 years ago

6.4.0

2 years ago

6.1.4

2 years ago

6.0.0

2 years ago

5.8.7

2 years ago

5.8.6

2 years ago

5.8.5

2 years ago

5.9.0

2 years ago

6.1.0

2 years ago

6.1.2

2 years ago

6.1.1

2 years ago

6.1.3

2 years ago

5.8.4

2 years ago

5.8.3

2 years ago

5.8.2

2 years ago

5.8.1

2 years ago

5.8.0

2 years ago

5.6.1

2 years ago

5.6.0

2 years ago

5.7.3

2 years ago

5.7.2

2 years ago

5.7.1

2 years ago

5.7.0

2 years ago

5.4.8

2 years ago

5.4.7

2 years ago

5.4.6

2 years ago

5.4.5

2 years ago

5.5.4

2 years ago

5.5.3

2 years ago

5.5.2

2 years ago

5.5.1

2 years ago

5.5.0

2 years ago

5.3.1

3 years ago

5.4.4

2 years ago

5.4.3

2 years ago

5.4.2

3 years ago

5.4.1

3 years ago

5.4.0

3 years ago

5.3.0

3 years ago

5.0.3

3 years ago

5.0.2

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

5.1.0

3 years ago

5.2.0

3 years ago

4.3.2

3 years ago

4.3.1

3 years ago

4.3.3

3 years ago

4.3.0

3 years ago

4.2.7

3 years ago

2.0.1

4 years ago

2.0.0

4 years ago

3.0.4

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

3.0.8

4 years ago

3.0.7

4 years ago

3.0.6

4 years ago

3.0.5

4 years ago

3.0.0

4 years ago

4.2.3

3 years ago

4.2.2

3 years ago

4.2.5

3 years ago

4.2.4

3 years ago

4.0.0

3 years ago

4.2.1

3 years ago

4.2.0

3 years ago

4.2.6

3 years ago

4.1.0

3 years ago

1.0.8-dev.x

4 years ago

1.0.8-dev.test1

4 years ago

1.0.8-dev.test

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago