Types

This page contains type definitions and options for Dokdo.

Dokdo

The main class of Dokdo.

You could access by parent variable in js(eval) command.

Constructor

new Dokdo(client, options)

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
client			none	DJS bot client
options			none	Options of Dokdo

Properties

.client

DJS bot client

Type:

.options

Options of Dokdo

Type:

.owners

User ID to allow to use dokdo

Type: []

Methods

.run(message)

Runs dokdo command

PARAMETER	TYPE	DESCRIPTION
message		Message on Discord

Returns:

DokdoOptions

interface DokdoOptions {
  prefix?: string
  noPerm?: (message: Message) => void
  secrets?: string[]
  aliases?: string[]
  globalVariable?: Record<string, any>
}

Types

Properties

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION	EXAMPLE
prefix			none	Prefix of Bot	'!'
aliases	[]	✅	['dokdo', 'dok']	dokdo command aliases	['debug']
owners	[]	✅	Fetch Application Owner(s) from Discord API	User ID to allow to use dokdo	['285185716240252929']
secrets	any[]	✅	[]	Secrets to hide at output	['superSecretPassword', 'youshallnotpass']
globalVariable		✅	{}	Custom global variable to use at eval	{ db: DatabaseQuery }
disableAttachmentExecution		✅	true	Disable command execution by attachment	false