Home Reference Source Repository

Function

Static Public Summary
public

find(searchString: *, message: *): *

public

handleMessage(message: *, oldMessage: *)

public

isAdmin(server: *, user: *): *

public

isMod(server: *, user: *): *

public

isUsable(command: *, message: *): *

public

loadYargs(yargs: *): *

public

makeResultObject(result: *): *

public

matchDefault(message: *, pattern: *, commandNameIndex: number): *

public

nameGroup(id: *, name: *)

public

parseMessage(message: *): *

public

register(command: *)

public

run(command: *, args: *, fromPattern: *, message: *): *

public

sendMessages(message: *, contents: *, type: *): *

public

sendMessagesForResult(message: *, result: *)

public

setDefaults(overwrite: boolean)

public

setValues(configObj: *)

public

updateMessages(message: *, oldMessages: *, contents: *, type: *): *

public

updateMessagesForResult(message: *, result: *, oldResult: *)

Static Public

public find(searchString: *, message: *): * source 

import {find} from 'discord-graf/src/commands/registry.js'

Params:

NameTypeAttributeDescription
searchString *
  • optional
  • default: null
message *
  • optional
  • default: null

Return:

*

public handleMessage(message: *, oldMessage: *) source 

import {handleMessage} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
oldMessage *
  • optional
  • default: null

public isAdmin(server: *, user: *): * source 

import {isAdmin} from 'discord-graf/src/permissions.js'

Params:

NameTypeAttributeDescription
server *
user *

Return:

*

public isMod(server: *, user: *): * source 

import {isMod} from 'discord-graf/src/permissions.js'

Params:

NameTypeAttributeDescription
server *
user *

Return:

*

public isUsable(command: *, message: *): * source 

import {isUsable} from 'discord-graf/src/commands/registry.js'

Params:

NameTypeAttributeDescription
command *
message *
  • optional
  • default: null

Return:

*

public loadYargs(yargs: *): * source 

import {loadYargs} from 'discord-graf/src/config.js'

Params:

NameTypeAttributeDescription
yargs *

Return:

*

public makeResultObject(result: *): * source 

import {makeResultObject} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
result *

Return:

*

public matchDefault(message: *, pattern: *, commandNameIndex: number): * source 

import {matchDefault} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
pattern *
commandNameIndex number
  • optional
  • default: 1

Return:

*

public nameGroup(id: *, name: *) source 

import {nameGroup} from 'discord-graf/src/commands/registry.js'

Params:

NameTypeAttributeDescription
id *
name *

public parseMessage(message: *): * source 

import {parseMessage} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *

Return:

*

public register(command: *) source 

import {register} from 'discord-graf/src/commands/registry.js'

Params:

NameTypeAttributeDescription
command *

public run(command: *, args: *, fromPattern: *, message: *): * source 

import {run} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
command *
args *
fromPattern *
message *

Return:

*

public sendMessages(message: *, contents: *, type: *): * source 

import {sendMessages} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
contents *
type *

Return:

*

public sendMessagesForResult(message: *, result: *) source 

import {sendMessagesForResult} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
result *

public setDefaults(overwrite: boolean) source 

import {setDefaults} from 'discord-graf/src/config.js'

Params:

NameTypeAttributeDescription
overwrite boolean
  • optional
  • default: false

public setValues(configObj: *) source 

import {setValues} from 'discord-graf/src/config.js'

Params:

NameTypeAttributeDescription
configObj *

public updateMessages(message: *, oldMessages: *, contents: *, type: *): * source 

import {updateMessages} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
oldMessages *
contents *
type *

Return:

*

public updateMessagesForResult(message: *, result: *, oldResult: *) source 

import {updateMessagesForResult} from 'discord-graf/src/commands/dispatcher.js'

Params:

NameTypeAttributeDescription
message *
result *
oldResult *