-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.d.ts
38 lines (30 loc) · 1.34 KB
/
types.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
import { MessagePayload, ReplyMessageOptions } from "discord.js";
import { StateManager } from "./src/helpers/stateManager";
export type Usage = ('message'|'server')[]
export type CmdStructure = 'string'|'number'|'string|null'|'number|null';
export type CommandSettings = {
/**Define the structure of your command
* - Like in this example: `r cal add 1 2`
* - The structure can be: `['string', 'number', 'number']`
* - structure is defined only for the fields that occur after cmd name. Here it is defined for
* `add 1 2`: `(string, number, number)`
* - leave the structure array empty if you want to avoid this feature
* - If structure is defined, you can use `.extract()` method to get the fields in sequence
*/
structure:CmdStructure[],
/**Your bot will throw errors in some specific cases like if a cmd doesn't match up
* with the structure defined for it.
* - Only for development purposes, turn it off during production
*/
strict?:boolean,
/**name of the command, optional: only for debugging*/
name?:string
/**state instance */
states?:StateManager;
/**minutes for which a msg will listen to states, default: 15 mins */
till?:'forever'|number;
}
export type States = {
[index: string]: any
}
export type Payload = string | MessagePayload | ReplyMessageOptions;