QuackJS

The main class for creating and managing Discord bots

Implements

  • QuackJSObject

Constructors

constructor

• new QuackJS(token, config)

Creates an instance of QuackJS.

Parameters

Name
Type
Description

token

string

The Discord bot's token.

config

QuackJSConfig

The config of the Discord bot.

Defined in

src/index.ts:32

Properties

client

• client: Client<boolean>

Implementation of

QuackJSObject.client

Defined in

src/index.ts:17


commands

• commands: QuackJSSlashCommand[]

Implementation of

QuackJSObject.commands

Defined in

src/index.ts:18


config

• config: QuackJSConfig

Implementation of

QuackJSObject.config

Defined in

src/index.ts:16


events

• events: QuackJSEvent[]

Implementation of

QuackJSObject.events

Defined in

src/index.ts:20


models

• models: Record<string, ModelStatic<Model<any, any>>>

Implementation of

QuackJSObject.models

Defined in

src/index.ts:22


sequelize

• sequelize: undefined | Sequelize

Implementation of

QuackJSObject.sequelize

Defined in

src/index.ts:21


token

• Private token: string

Defined in

src/index.ts:24


triggers

• triggers: QuackJSTrigger[]

Implementation of

QuackJSObject.triggers

Defined in

src/index.ts:19

Methods

AddModel

â–¸ AddModel(name, model): void

A method for adding models for the Database.

Parameters

Name
Type
Description

name

string

The name of the model.

model

ModelStatic<Model<any, any>>

The model to be used for the Database.

Returns

void

Defined in

src/index.ts:198


CreateCommand

â–¸ CreateCommand(slashCommand): void

Adds a slash command to the object.

Parameters

Name
Type
Description

slashCommand

QuackJSSlashCommand

The slash command to be added.

Returns

void

Defined in

src/index.ts:208


CreateEvent

â–¸ CreateEvent(event): void

Adds an event to the object.

Parameters

Name
Type
Description

event

QuackJSEvent

The event to be added.

Returns

void

Defined in

src/index.ts:217


CreateTrigger

â–¸ CreateTrigger(trigger): void

Adds a trigger to the object.

Parameters

Name
Type
Description

trigger

QuackJSTrigger

The trigger to be added.

Returns

void

Defined in

src/index.ts:226


Login

â–¸ Private Login(): Promise<unknown>

Returns

Promise<unknown>

Defined in

src/index.ts:186


Start

â–¸ Start(QuackJS): Promise<void>

Starts the Discord bot.

Parameters

Name
Type
Description

QuackJS

QuackJS

The parameter of this class.

Returns

Promise<void>

Defined in

src/index.ts:80


StartEvents

â–¸ Private StartEvents(): Promise<void>

Returns

Promise<void>

Defined in

src/index.ts:180

Last updated