This repository has been archived by the owner on Aug 28, 2020. It is now read-only.
/
index.d.ts
1933 lines (1663 loc) · 70.1 KB
/
index.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare module 'klasa' {
import {
BufferResolvable,
Channel,
Client,
ClientApplication,
ClientOptions,
ClientUser,
ClientUserGuildSettings,
ClientUserSettings,
Collection,
DMChannel as DiscordDMChannel,
Emoji,
GroupDMChannel as DiscordGroupDMChannel,
Guild as DiscordGuild,
GuildMember,
Message as DiscordMessage,
MessageAttachment,
MessageCollector,
MessageEmbed,
MessageOptions,
MessageReaction,
ReactionCollector,
Role,
Snowflake,
StringResolvable,
TextChannel as DiscordTextChannel,
User as DiscordUser,
UserResolvable,
VoiceChannel as DiscordVoiceChannel,
WebhookClient
} from 'discord.js';
export const version: string;
//#region Classes
export class KlasaClient extends Client {
public constructor(options?: KlasaClientOptions & ClientOptions);
public options: KlasaClientOptions & ClientOptions;
public coreBaseDir: string;
public clientBaseDir: string;
public console: KlasaConsole;
public argResolver: ArgResolver;
public commands: CommandStore;
public inhibitors: InhibitorStore;
public finalizers: FinalizerStore;
public monitors: MonitorStore;
public languages: LanguageStore;
public providers: ProviderStore;
public tasks: TaskStore;
public events: EventStore;
public extendables: ExtendableStore;
public pieceStores: Collection<string, any>;
public permissionLevels: PermissionLevels;
public sharded: boolean;
public methods: {
Collection: typeof Collection;
Embed: typeof MessageEmbed;
KlasaMessage: typeof KlasaMessage;
MessageCollector: typeof MessageCollector;
Webhook: typeof WebhookClient;
util: typeof Util;
};
public gateways: GatewayDriver;
public configs?: Configuration;
public application: ClientApplication;
public schedule: Schedule;
public ready: boolean;
public readonly invite: string;
public readonly owner: KlasaUser;
public validatePermissionLevels(): PermissionLevels;
public registerStore<K, V>(store: Store<K, V>): KlasaClient;
public unregisterStore<K, V>(store: Store<K, V>): KlasaClient;
public registerPiece<K, V>(pieceName: string, store: Store<K, V>): KlasaClient;
public unregisterPiece(pieceName: string): KlasaClient;
public login(token: string): Promise<string>;
private _ready(): Promise<void>;
public sweepMessages(lifetime?: number, commandLifeTime?: number): number;
public static defaultPermissionLevels: PermissionLevels;
// Discord.js events
public on(event: string, listener: Function): this;
public on(event: 'channelCreate' | 'channelDelete', listener: (channel: Channel) => void): this;
public on(event: 'channelPinsUpdate', listener: (channel: Channel, time: Date) => void): this;
public on(event: 'channelUpdate', listener: (oldChannel: Channel, newChannel: Channel) => void): this;
public on(event: 'clientUserGuildSettingsUpdate', listener: (clientUserGuildSettings: ClientUserGuildSettings) => void): this;
public on(event: 'clientUserGuildSettingsUpdate', listener: (clientUserGuildSettings: ClientUserGuildSettings) => void): this;
public on(event: 'clientUserSettingsUpdate', listener: (clientUserSettings: ClientUserSettings) => void): this;
public on(event: 'debug' | 'warn', listener: (info: string) => void): this;
public on(event: 'disconnect', listener: (event: any) => void): this;
public on(event: 'emojiCreate | emojiDelete', listener: (emoji: Emoji) => void): this;
public on(event: 'emojiUpdate', listener: (oldEmoji: Emoji, newEmoji: Emoji) => void): this;
public on(event: 'error', listener: (error: Error) => void): this;
public on(event: 'guildBanAdd' | 'guildBanRemove', listener: (guild: KlasaGuild, user: KlasaUser) => void): this;
public on(event: 'guildCreate' | 'guildDelete' | 'guildUnavailable', listener: (guild: KlasaGuild) => void): this;
public on(event: 'guildMemberAdd' | 'guildMemberAvailable' | 'guildMemberRemove', listener: (member: GuildMember) => void): this;
public on(event: 'guildMembersChunk', listener: (members: GuildMember[], guild: KlasaGuild) => void): this;
public on(event: 'guildMemberSpeaking', listener: (member: GuildMember, speaking: boolean) => void): this;
public on(event: 'guildMemberUpdate' | 'presenceUpdate' | 'voiceStateUpdate', listener: (oldMember: GuildMember, newMember: GuildMember) => void): this;
public on(event: 'guildUpdate', listener: (oldGuild: KlasaGuild, newGuild: KlasaGuild) => void): this;
public on(event: 'message' | 'messageDelete' | 'messageReactionRemoveAll', listener: (message: KlasaMessage) => void): this;
public on(event: 'messageDeleteBulk', listener: (messages: Collection<Snowflake, KlasaMessage>) => void): this;
public on(event: 'messageReactionAdd' | 'messageReactionRemove', listener: (messageReaction: MessageReaction, user: KlasaUser) => void): this;
public on(event: 'messageUpdate', listener: (oldMessage: KlasaMessage, newMessage: KlasaMessage) => void): this;
public on(event: 'ready' | 'reconnecting' | 'resume', listener: () => void): this;
public on(event: 'roleCreate' | 'roleDelete', listener: (role: Role) => void): this;
public on(event: 'roleUpdate', listener: (oldRole: Role, newRole: Role) => void): this;
public on(event: 'typingStart' | 'typingStop', listener: (channel: Channel, user: KlasaUser) => void): this;
public on(event: 'userNoteUpdate', listener: (user: UserResolvable, oldNote: string, newNote: string) => void): this;
public on(event: 'userUpdate', listener: (oldUser: KlasaUser, newUser: KlasaUser) => void): this;
// Klasa Command Events
public on(event: 'commandError', listener: (msg: KlasaMessage, command: Command, params: any[], error: Error) => void): this;
public on(event: 'commandInhibited', listener: (msg: KlasaMessage, command: Command, response: string | Error) => void): this;
public on(event: 'commandRun', listener: (msg: KlasaMessage, command: Command, params: any[], response: any) => void): this;
public on(event: 'commandSuccess', listener: (msg: KlasaMessage, command: Command, params: any[], response: any) => void): this;
public on(event: 'commandUnknown', listener: (msg: KlasaMessage, command: string) => void): this;
public on(event: 'monitorError', listener: (msg: KlasaMessage, monitor: Monitor, error: Error | string) => void): this;
public on(event: 'finalizerError', listener: (msg: KlasaMessage, mes: KlasaMessage, timer: Timestamp, finalizer: Finalizer, error: Error | string) => void): this;
public on(event: 'taskError', listener: (scheduledTask: ScheduledTask, task: Task, error: Error) => void): this;
// SettingGateway Events
public on(event: 'configCreateEntry', listener: (entry: Configuration) => void): this;
public on(event: 'configDeleteEntry', listener: (entry: Configuration) => void): this;
public on(event: 'configUpdateEntry', listener: (oldEntry: Configuration, newEntry: Configuration, path: string | ConfigUpdateEntryMany) => void): this;
// Schema Events
public on(event: 'schemaKeyAdd', listener: (key: SchemaFolder | SchemaPiece) => void): this;
public on(event: 'schemaKeyRemove', listener: (key: SchemaFolder | SchemaPiece) => void): this;
public on(event: 'schemaKeyUpdate', listener: (key: SchemaPiece) => void): this;
// Klasa Console Custom Events
public on(event: 'log', listener: (data: any, type: string) => void): this;
public on(event: 'verbose', listener: (data: any) => void): this;
public on(event: 'wtf', listener: (failure: Error) => void): this;
// Klasa Piece Events
public on(event: 'pieceDisabled', listener: (piece: Piece) => void): this;
public on(event: 'pieceEnabled', listener: (piece: Piece) => void): this;
public on(event: 'pieceLoaded', listener: (piece: Piece) => void): this;
public on(event: 'pieceReloaded', listener: (piece: Piece) => void): this;
public on(event: 'pieceUnloaded', listener: (piece: Piece) => void): this;
// Discord.js events
public once(event: string, listener: Function): this;
public once(event: 'channelCreate' | 'channelDelete', listener: (channel: Channel) => void): this;
public once(event: 'channelPinsUpdate', listener: (channel: Channel, time: Date) => void): this;
public once(event: 'channelUpdate', listener: (oldChannel: Channel, newChannel: Channel) => void): this;
public once(event: 'clientUserGuildSettingsUpdate', listener: (clientUserGuildSettings: ClientUserGuildSettings) => void): this;
public once(event: 'clientUserGuildSettingsUpdate', listener: (clientUserGuildSettings: ClientUserGuildSettings) => void): this;
public once(event: 'clientUserSettingsUpdate', listener: (clientUserSettings: ClientUserSettings) => void): this;
public once(event: 'debug' | 'warn', listener: (info: string) => void): this;
public once(event: 'disconnect', listener: (event: any) => void): this;
public once(event: 'emojiCreate | emojiDelete', listener: (emoji: Emoji) => void): this;
public once(event: 'emojiUpdate', listener: (oldEmoji: Emoji, newEmoji: Emoji) => void): this;
public once(event: 'error', listener: (error: Error) => void): this;
public once(event: 'guildBanAdd' | 'guildBanRemove', listener: (guild: KlasaGuild, user: KlasaUser) => void): this;
public once(event: 'guildCreate' | 'guildDelete' | 'guildUnavailable', listener: (guild: KlasaGuild) => void): this;
public once(event: 'guildMemberAdd' | 'guildMemberAvailable' | 'guildMemberRemove', listener: (member: GuildMember) => void): this;
public once(event: 'guildMembersChunk', listener: (members: GuildMember[], guild: KlasaGuild) => void): this;
public once(event: 'guildMemberSpeaking', listener: (member: GuildMember, speaking: boolean) => void): this;
public once(event: 'guildMemberUpdate' | 'presenceUpdate' | 'voiceStateUpdate', listener: (oldMember: GuildMember, newMember: GuildMember) => void): this;
public once(event: 'guildUpdate', listener: (oldGuild: KlasaGuild, newGuild: KlasaGuild) => void): this;
public once(event: 'message' | 'messageDelete' | 'messageReactionRemoveAll', listener: (message: KlasaMessage) => void): this;
public once(event: 'messageDeleteBulk', listener: (messages: Collection<Snowflake, KlasaMessage>) => void): this;
public once(event: 'messageReactionAdd' | 'messageReactionRemove', listener: (messageReaction: MessageReaction, user: KlasaUser) => void): this;
public once(event: 'messageUpdate', listener: (oldMessage: KlasaMessage, newMessage: KlasaMessage) => void): this;
public once(event: 'ready' | 'reconnecting' | 'resume', listener: () => void): this;
public once(event: 'roleCreate' | 'roleDelete', listener: (role: Role) => void): this;
public once(event: 'roleUpdate', listener: (oldRole: Role, newRole: Role) => void): this;
public once(event: 'typingStart' | 'typingStop', listener: (channel: Channel, user: KlasaUser) => void): this;
public once(event: 'userNoteUpdate', listener: (user: UserResolvable, oldNote: string, newNote: string) => void): this;
public once(event: 'userUpdate', listener: (oldUser: KlasaUser, newUser: KlasaUser) => void): this;
// Klasa Command Events
public once(event: 'commandError', listener: (msg: KlasaMessage, command: Command, params: any[], error: Error) => void): this;
public once(event: 'commandInhibited', listener: (msg: KlasaMessage, command: Command, response: string | Error) => void): this;
public once(event: 'commandRun', listener: (msg: KlasaMessage, command: Command, params: any[], response: any) => void): this;
public once(event: 'commandSuccess', listener: (msg: KlasaMessage, command: Command, params: any[], response: any) => void): this;
public once(event: 'commandUnknown', listener: (msg: KlasaMessage, command: string) => void): this;
public once(event: 'monitorError', listener: (msg: KlasaMessage, monitor: Monitor, error: Error | string) => void): this;
public once(event: 'finalizerError', listener: (msg: KlasaMessage, mes: KlasaMessage, timer: Timestamp, finalizer: Finalizer, error: Error | string) => void): this;
public once(event: 'taskError', listener: (scheduledTask: ScheduledTask, task: Task, error: Error) => void): this;
// SettingGateway Events
public once(event: 'configCreateEntry', listener: (entry: Configuration) => void): this;
public once(event: 'configDeleteEntry', listener: (entry: Configuration) => void): this;
public once(event: 'configUpdateEntry', listener: (oldEntry: Configuration, newEntry: Configuration, path?: string) => void): this;
// Schema Events
public once(event: 'schemaKeyAdd', listener: (key: SchemaFolder | SchemaPiece) => void): this;
public once(event: 'schemaKeyRemove', listener: (key: SchemaFolder | SchemaPiece) => void): this;
public once(event: 'schemaKeyUpdate', listener: (key: SchemaPiece) => void): this;
// Klasa Console Custom Events
public once(event: 'log', listener: (data: any, type: string) => void): this;
public once(event: 'verbose', listener: (data: any) => void): this;
public once(event: 'wtf', listener: (failure: Error) => void): this;
// Klasa Piece Events
public once(event: 'pieceDisabled', listener: (piece: Piece) => void): this;
public once(event: 'pieceEnabled', listener: (piece: Piece) => void): this;
public once(event: 'pieceLoaded', listener: (piece: Piece) => void): this;
public once(event: 'pieceReloaded', listener: (piece: Piece) => void): this;
public once(event: 'pieceUnloaded', listener: (piece: Piece) => void): this;
}
export { KlasaClient as Client };
//#region Extensions
export class KlasaGuild extends DiscordGuild {
public configs: Configuration;
public readonly language: Language;
}
export class KlasaMessage extends DiscordMessage {
public readonly guild: KlasaGuild;
public guildConfigs: Configuration;
public language: Language;
public responses?: KlasaMessage | KlasaMessage[];
public command?: Command;
public prefix?: RegExp;
public prefixLength?: number;
private prompter?: CommandPrompt;
public readonly args: string[];
public readonly params: any[];
public readonly flags: object;
public readonly reprompted: boolean;
public readonly reactable: boolean;
public prompt(text: string, time?: number): Promise<KlasaMessage>;
public usableCommands(): Promise<Collection<string, Command>>;
public hasAtLeastPermissionLevel(min: number): Promise<boolean>;
public sendMessage(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendCode(lang: string, content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public send(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
private _patch(data: any): void;
private _registerCommand(commandInfo: { command: Command, prefix: RegExp, prefixLength: number }): void;
private static combineContentOptions(content?: StringResolvable, options?: MessageOptions): MessageOptions;
}
export class KlasaUser extends DiscordUser {
public configs: Configuration;
public send(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public send(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendCode(lang: string, content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, options?: MessageOptions): Promise<KlasaMessage>;
public sendFile(attachment: BufferResolvable, name?: string, content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendFiles(attachments: MessageAttachment[], content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
}
export class KlasaTextChannel extends DiscordTextChannel {
public readonly attachable: boolean;
public readonly embedable: boolean;
public readonly postable: boolean;
public readonly guild: KlasaGuild;
public send(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public send(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendCode(lang: string, content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, options?: MessageOptions): Promise<KlasaMessage>;
public sendFile(attachment: BufferResolvable, name?: string, content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendFiles(attachments: MessageAttachment[], content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
}
export class KlasaVoiceChannel extends DiscordVoiceChannel {
public readonly guild: KlasaGuild;
}
export class KlasaDMChannel extends DiscordDMChannel {
public readonly attachable: boolean;
public readonly embedable: boolean;
public readonly postable: boolean;
public send(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public send(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendCode(lang: string, content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, options?: MessageOptions): Promise<KlasaMessage>;
public sendFile(attachment: BufferResolvable, name?: string, content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendFiles(attachments: MessageAttachment[], content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
}
export class KlasaGroupDMChannel extends DiscordGroupDMChannel {
public readonly attachable: boolean;
public readonly embedable: boolean;
public readonly postable: boolean;
public send(content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public send(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendCode(lang: string, content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendEmbed(embed: MessageEmbed, options?: MessageOptions): Promise<KlasaMessage>;
public sendFile(attachment: BufferResolvable, name?: string, content?: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendFiles(attachments: MessageAttachment[], content: StringResolvable, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(content?: string, options?: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
public sendMessage(options: MessageOptions): Promise<KlasaMessage | KlasaMessage[]>;
}
//#endregion Extensions
//#region Parsers
export class ArgResolver extends Resolver {
public custom(arg: string, possible: Possible, msg: KlasaMessage, custom: ArgResolverCustomMethod): Promise<any>;
public piece(arg: string, possible: Possible, msg: KlasaMessage): Promise<Piece>;
public store<K, V>(arg: string, possible: Possible, msg: KlasaMessage): Promise<Store<K, V>>;
public cmd(arg: string, possible: Possible, msg: KlasaMessage): Promise<Command>;
public command(arg: string, possible: Possible, msg: KlasaMessage): Promise<Command>;
public event(arg: string, possible: Possible, msg: KlasaMessage): Promise<Event>;
public extendable(arg: string, possible: Possible, msg: KlasaMessage): Promise<Extendable>;
public finalizer(arg: string, possible: Possible, msg: KlasaMessage): Promise<Finalizer>;
public inhibitor(arg: string, possible: Possible, msg: KlasaMessage): Promise<Inhibitor>;
public language(arg: string, possible: Possible, msg: KlasaMessage): Promise<Language>;
public monitor(arg: string, possible: Possible, msg: KlasaMessage): Promise<Monitor>;
public provider(arg: string, possible: Possible, msg: KlasaMessage): Promise<Provider>;
public task(arg: string, possible: Possible, msg: KlasaMessage): Promise<Task>;
public message(arg: string, possible: Possible, msg: KlasaMessage): Promise<KlasaMessage>;
public msg(arg: string, possible: Possible, msg: KlasaMessage): Promise<KlasaMessage>;
public mention(arg: string, possible: Possible, msg: KlasaMessage): Promise<KlasaUser>;
public user(arg: string, possible: Possible, msg: KlasaMessage): Promise<KlasaUser>;
public member(arg: string, possible: Possible, msg: KlasaMessage): Promise<GuildMember>;
public channel(arg: string, possible: Possible, msg: KlasaMessage): Promise<Channel>;
public emoji(arg: string, possible: Possible, msg: KlasaMessage): Promise<Emoji>;
public guild(arg: string, possible: Possible, msg: KlasaMessage): Promise<KlasaGuild>;
public role(arg: string, possible: Possible, msg: KlasaMessage): Promise<Role>;
public literal(arg: string, possible: Possible, msg: KlasaMessage): Promise<string>;
public boolean(arg: string, possible: Possible, msg: KlasaMessage): Promise<boolean>;
public bool(arg: string, possible: Possible, msg: KlasaMessage): Promise<boolean>;
public string(arg: string, possible: Possible, msg: KlasaMessage): Promise<string>;
public str(arg: string, possible: Possible, msg: KlasaMessage): Promise<string>;
public integer(arg: string, possible: Possible, msg: KlasaMessage): Promise<number>;
public int(arg: string, possible: Possible, msg: KlasaMessage): Promise<number>;
public num(arg: string, possible: Possible, msg: KlasaMessage): Promise<number>;
public number(arg: string, possible: Possible, msg: KlasaMessage): Promise<number>;
public float(arg: string, possible: Possible, msg: KlasaMessage): Promise<number>;
public reg(arg: string, possible: Possible, msg: KlasaMessage): Promise<RegExpExecArray>;
public regex(arg: string, possible: Possible, msg: KlasaMessage): Promise<RegExpExecArray>;
public regexp(arg: string, possible: Possible, msg: KlasaMessage): Promise<RegExpExecArray>;
public url(arg: string, possible: Possible, msg: KlasaMessage): Promise<string>;
public date(arg: string, possible: Possible, msg: KlasaMessage): Promise<Date>;
public duration(arg: string, possible: Possible, msg: KlasaMessage): Promise<Date>;
public time(arg: string, possible: Possible, msg: KlasaMessage): Promise<Date>;
// Overloads for TS retrocompatibility
public message(input: string | KlasaMessage, channel: Channel): Promise<KlasaMessage>;
public msg(input: string | KlasaMessage, channel: Channel): Promise<KlasaMessage>;
public mention(input: KlasaUser | GuildMember | KlasaMessage | Snowflake): Promise<KlasaUser>;
public user(input: KlasaUser | GuildMember | KlasaMessage | Snowflake): Promise<KlasaUser>;
public member(input: KlasaUser | GuildMember | Snowflake, guild: KlasaGuild): Promise<GuildMember>;
public channel(input: Channel | Snowflake): Promise<Channel>;
public guild(input: KlasaGuild | Snowflake): Promise<KlasaGuild>;
public role(input: Role | Snowflake, guild: KlasaGuild): Promise<Role>;
public boolean(input: boolean | string): Promise<boolean>;
public bool(input: boolean | string): Promise<boolean>;
public string(input: string): Promise<string>;
public str(input: string): Promise<string>;
public integer(input: string | number): Promise<number>;
public int(input: string | number): Promise<number>;
public num(input: string | number): Promise<number>;
public number(input: string | number): Promise<number>;
public float(input: string | number): Promise<number>;
public url(input: string): Promise<string>;
private static minOrMax(client: KlasaClient, value: number, min: number, max: number, possible: Possible, msg: KlasaMessage, suffix: string): boolean;
}
export class Resolver {
public constructor(client: KlasaClient);
public readonly client: KlasaClient;
public boolean(input: boolean | string): Promise<boolean>;
public channel(input: Channel | Snowflake): Promise<Channel>;
public float(input: string | number): Promise<number>;
public guild(input: KlasaGuild | Snowflake): Promise<KlasaGuild>;
public integer(input: string | number): Promise<number>;
public member(input: KlasaUser | GuildMember | Snowflake, guild: KlasaGuild): Promise<GuildMember>;
public msg(input: KlasaMessage | Snowflake, channel: Channel): Promise<KlasaMessage>;
public role(input: Role | Snowflake, guild: KlasaGuild): Promise<Role>;
public string(input: string): Promise<string>;
public url(input: string): Promise<string>;
public user(input: KlasaUser | GuildMember | KlasaMessage | Snowflake): Promise<KlasaUser>;
public static readonly regex: {
userOrMember: RegExp,
channel: RegExp,
role: RegExp,
snowflake: RegExp
};
}
export class SettingResolver extends Resolver {
public any(data: any): Promise<any>;
public boolean(data: any, guild: KlasaGuild, name: string): Promise<boolean>;
public boolean(input: boolean | string): Promise<boolean>;
public channel(data: any, guild: KlasaGuild, name: string): Promise<Channel>;
public channel(input: Channel | Snowflake): Promise<Channel>;
public command(data: any, guild: KlasaGuild, name: string): Promise<Command>;
public float(data: any, guild: KlasaGuild, name: string, minMax: { min: number, max: number }): Promise<number>;
public float(input: string | number): Promise<number>;
public guild(data: any, guild: KlasaGuild, name: string): Promise<KlasaGuild>;
public guild(input: KlasaGuild | Snowflake): Promise<KlasaGuild>;
public integer(data: any, guild: KlasaGuild, name: string, minMax: { min: number, max: number }): Promise<number>;
public integer(input: string | number): Promise<number>;
public language(data: any, guild: KlasaGuild, name: string): Promise<Language>;
public role(data: any, guild: KlasaGuild, name: string): Promise<Role>;
public role(input: Role | Snowflake, guild: KlasaGuild): Promise<Role>;
public string(data: any, guild: KlasaGuild, name: string, minMax: { min: number, max: number }): Promise<string>;
public string(input: string): Promise<string>;
public textchannel(data: any, guild: KlasaGuild, name: string): Promise<KlasaTextChannel>;
public url(data: any, guild: KlasaGuild, name: string): Promise<string>;
public url(input: string): Promise<string>;
public user(data: any, guild: KlasaGuild, name: string): Promise<KlasaUser>;
public user(input: KlasaUser | GuildMember | KlasaMessage | Snowflake): Promise<KlasaUser>;
public voicechannel(data: any, guild: KlasaGuild, name: string): Promise<KlasaVoiceChannel>;
public static maxOrMin(guild: KlasaGuild, value: number, min: number, max: number, name: string, suffix: string): boolean;
}
//#endregion Parsers
//#region Permissions
export class PermissionLevels extends Collection<number, PermissionLevel> {
public constructor(levels?: number);
public requiredLevels: number;
public addLevel(level: number, brk: boolean, check: (client: KlasaClient, msg: KlasaMessage) => boolean): this;
public set(level: number, obj: PermissionLevel): this;
public isValid(): boolean;
public debug(): string;
public run(msg: KlasaMessage, min: number): PermissionLevelsData;
}
//#endregion Permissions
//#region Schedule
export class Schedule {
public constructor(client: KlasaClient);
public client: KlasaClient;
public tasks: ScheduledTask[];
public timeInterval: number;
private _interval: NodeJS.Timer;
private readonly _tasks: ScheduledTaskOptions[];
public init(): Promise<void>;
public execute(): Promise<void>;
public next(): ScheduledTask;
public create(taskName: string, time: Date | number | string, options: ScheduledTaskOptions): Promise<ScheduledTask>;
public delete(id: string): Promise<this>;
public clear(): Promise<void>;
private _add(taskName: string, time: Date | number | string, options: ScheduledTaskOptions): ScheduledTask;
private _insert(task: ScheduledTask): ScheduledTask;
private _clearInterval(): void;
private _checkInterval(): void;
}
export class ScheduledTask {
public constructor(client: KlasaClient, taskName: string, time: Date | number | string, options?: ScheduledTaskOptions);
public readonly client: KlasaClient;
public readonly store: Schedule;
public taskName: string;
public recurring?: Cron;
public time?: Date;
public id: string;
public data: any;
public readonly task: Task;
public run(): Promise<this>;
public update(options?: ScheduledTaskUpdateOptions): Promise<this>;
public delete(): Promise<Schedule>;
public toJSON(): ScheduledTaskJSON;
private static _resolveTime(time: Date | number | Cron | string): [Date, Cron];
private static _generateID(client: KlasaClient, time: Date | number): string;
private static _validate(st: ScheduledTask): void;
}
//#endregion Schedule
//#region Settings
export class Configuration {
public constructor(manager: Gateway, data: any);
public readonly client: KlasaClient;
public readonly gateway: Gateway;
public readonly type: string;
public readonly id: string;
private _existsInDB: boolean;
private _syncStatus?: Promise<object>;
public get(key: string): any;
public clone(): Configuration;
public resetConfiguration(): Promise<Configuration>;
public sync(): Promise<this>;
public destroy(): Promise<this>;
public reset(key: string, avoidUnconfigurable?: boolean): Promise<ConfigurationUpdateResult>;
public update(key: object, guild?: GatewayGuildResolvable): Promise<ConfigurationUpdateManyResult>;
public update(key: string, value?: any, options?: ConfigurationUpdateOptions): Promise<ConfigurationUpdateResult>;
public update(key: string, value?: any, guild?: GatewayGuildResolvable, options?: ConfigurationUpdateOptions): Promise<ConfigurationUpdateResult>;
private _updateMany(object: any, guild?: GatewayGuildResolvable): Promise<ConfigurationUpdateManyResult>;
private _reset(key: string, guild: GatewayGuildResolvable, avoidUnconfigurable: boolean): Promise<ConfigurationParseResult>;
private _parseReset(key: string, guild: KlasaGuild, options: ConfigurationPathResult): Promise<ConfigurationParseResult>;
private _parseUpdateOne(key: string, value: any, guild: KlasaGuild, options: ConfigurationPathResult): Promise<ConfigurationParseResult>;
private _parseUpdateArray(action: 'add' | 'remove' | 'auto', key: string, value: any, guild: KlasaGuild, arrayPosition: number, options: ConfigurationPathResult): Promise<ConfigurationParseResult>;
private _parseUpdateMany(cache: any, object: any, schema: SchemaFolder, guild: KlasaGuild, list: ConfigurationUpdateManyResult, updateObject: object): void;
private _updateSingle(key: string, value: any, guild: KlasaGuild, options: ConfigurationUpdateOptions): Promise<ConfigurationParseResult>;
private _setValue(parsedID: string, path: SchemaPiece, route: string[]): Promise<void>;
private _patch(data: any): void;
public toJSON(): object;
public toString(): string;
private static _merge(data: any, folder: SchemaFolder | SchemaPiece): any;
private static _clone(data: any, schema: SchemaFolder): any;
private static _patch(inst: any, data: any, schema: SchemaFolder): void;
private static getIdentifier(value: any): any;
}
export class Gateway extends GatewayStorage {
private constructor(store: GatewayDriver, type: string, validateFunction: Function, schema: object, options: GatewayDriverAddOptions);
public store: GatewayDriver;
public options: GatewayDriverAddOptions;
public validate: Function;
public defaultSchema: object;
public readonly cache: Provider;
public readonly resolver: SettingResolver;
public getEntry(input: string, create?: boolean): object | Configuration;
public createEntry(input: string): Promise<Configuration>;
public insertEntry(id: string, data?: object): Configuration;
public deleteEntry(input: string): Promise<boolean>;
public sync(input?: object | string, download?: boolean): Promise<any>;
public getPath(key?: string, options?: GatewayGetPathOptions): GatewayGetPathResult;
private init(download?: boolean): Promise<void>;
private _ready(): Promise<Array<Collection<string, Configuration>>>;
private _resolveGuild(guild: GatewayGuildResolvable): KlasaGuild;
private _shardSync(path: string[], data: any, action: 'add' | 'delete' | 'update', force: boolean): Promise<void>;
public toString(): string;
}
export class GatewayDriver {
private constructor(client: KlasaClient);
public readonly client: KlasaClient;
public resolver: SettingResolver;
public types: string[];
public caches: string[];
public ready: boolean;
public readonly guildsSchema: {
prefix: SchemaPieceJSON,
language: SchemaPieceJSON,
disableNaturalPrefix: SchemaPieceJSON,
disabledCommands: SchemaPieceJSON
};
public readonly clientStorageSchema: {
userBlacklist: SchemaPieceJSON,
guildBlacklist: SchemaPieceJSON,
schedules: SchemaPieceJSON
};
public guilds: Gateway;
public users: Gateway;
public clientStorage: Gateway;
public add(name: string, validateFunction: Function, schema?: object, options?: GatewayDriverAddOptions, download?: boolean): Promise<Gateway>;
private _ready(): Promise<Array<Array<Collection<string, Configuration>>>>;
private _checkProvider(engine: string): string;
}
export abstract class GatewayStorage {
public constructor(client: KlasaClient, type: string, provider?: string);
public readonly client: KlasaClient;
public readonly type: string;
public readonly providerName: string;
public readonly baseDir: string;
public readonly filePath: string;
public readonly sql: boolean;
public schema?: SchemaFolder;
public ready: boolean;
public readonly sqlSchema: string[][];
public readonly provider: Provider;
public readonly defaults: any;
private initTable(): Promise<void>;
private initSchema(): Promise<SchemaFolder>;
private parseEntry(entry: any): any;
private static throwError(guild: KlasaGuild, code: string | number, error: string | Error): string;
private static _parseSQLValue(value: any, schemaPiece: SchemaPiece): any;
}
export abstract class Schema {
public constructor(client: KlasaClient, gateway: Gateway, object: any, parent: SchemaFolder, key: string);
public readonly client: KlasaClient;
public readonly gateway: Gateway;
public readonly parent?: SchemaFolder;
public readonly path: string;
public readonly key: string;
private readonly _inited: true;
}
export class SchemaFolder extends Schema {
private constructor(client: KlasaClient, gateway: Gateway, object: any, parent: SchemaFolder, key: string);
public readonly type: 'Folder';
public defaults: object;
public keys: Set<string>;
public keyArray: string[];
public readonly configurableKeys: string[];
public addFolder(key: string, object?: object, force?: boolean): Promise<SchemaFolder>;
public removeFolder(key: string, force?: boolean): Promise<SchemaFolder>;
public hasKey(key: string): boolean;
public addKey(key: string, options: SchemaFolderAddOptions, force?: boolean): Promise<SchemaFolder>;
public removeKey(key: string, force?: boolean): Promise<SchemaFolder>;
public force(action: 'add' | 'edit' | 'delete', key: string, piece: SchemaFolder | SchemaPiece): Promise<any>;
public getList(msg: KlasaMessage): string;
public getDefaults(data?: object): object;
public getSQL(array?: string[]): string[];
public getKeys(array?: string[]): string[];
public getValues(array?: SchemaPiece[]): SchemaPiece[];
public resolveString(): string;
private _addKey(key: string, options: SchemaFolderAddOptions, type: typeof Schema | typeof SchemaFolder): void;
private _removeKey(key: string): void;
private _init(options: object): true;
public toJSON(): any;
public toString(): string;
}
export class SchemaPiece extends Schema {
private constructor(client: KlasaClient, gateway: Gateway, options: SchemaFolderAddOptions, parent: SchemaFolder, key: string);
public type: string;
public array: boolean;
public default: any;
public min?: number;
public max?: number;
public sql: [string, string];
public configurable: boolean;
public validator?: (resolved: any, guild?: KlasaGuild) => void;
public setValidator(fn: Function): this;
public parse(value: any, guild: KlasaGuild): Promise<any>;
public resolveString(msg: KlasaMessage): string;
public modify(options: SchemaPieceModifyOptions): Promise<this>;
private _schemaCheckType(type: string): void;
private _schemaCheckArray(array: boolean): void;
private _schemaCheckDefault(options: SchemaFolderAddOptions): void;
private _schemaCheckLimits(min: number, max: number): void;
private _schemaCheckConfigurable(configurable: boolean): void;
private _generateSQLDatatype(sql?: string): string;
private _init(options: SchemaFolderAddOptions): true;
public toJSON(): SchemaPieceJSON;
public toString(): string;
private static _parseSQLValue(value: any): string;
}
//#endregion Settings
//#region Pieces
export class Piece {
public constructor(client: KlasaClient, store: Store<string, Piece>, type: string, file: string | string[], core: boolean, options?: PieceOptions);
public readonly client: KlasaClient;
public readonly core: boolean;
public readonly type: string;
public file: string | string[];
public name: string;
public enabled: boolean;
public store: Store<string, this>;
public reload(): Promise<Piece>;
public unload(): void;
public enable(): Piece;
public disable(): Piece;
public init(): Promise<any>;
public toJSON(): PieceJSON;
public toString(): string;
}
export abstract class Command extends Piece {
public constructor(client: KlasaClient, store: CommandStore, file: string[], core: boolean, options?: CommandOptions);
public readonly category: string;
public readonly subCategory: string;
public readonly usageDelim: string;
public readonly usageString: string;
public aliases: string[];
public botPerms: string[];
public bucket: number;
public cooldown: number;
public deletable: boolean;
public description: string | ((msg: KlasaMessage) => string);
public extendedHelp: string | ((msg: KlasaMessage) => string);
public fullCategory: string[];
public guarded: boolean;
public nsfw: boolean;
public permLevel: number;
public promptLimit: number;
public promptTime: number;
public quotedStringSupport: boolean;
public requiredConfigs: string[];
public runIn: string[];
public subcommands: boolean;
public usage: CommandUsage;
private cooldowns: Map<Snowflake, number>;
public definePrompt(usageString: string, usageDelim: string): Usage;
public createCustomResolver(type: string, resolver: ArgResolverCustomMethod): this;
public customizeResponse(name: string, response: string | ((msg: KlasaMessage, possible: Possible) => string)): this;
public run(msg: KlasaMessage, params: any[]): Promise<KlasaMessage | KlasaMessage[]>;
public toJSON(): PieceCommandJSON;
}
export abstract class Event extends Piece {
public constructor(client: KlasaClient, store: EventStore, file: string, core: boolean, options?: EventOptions);
public abstract run(...params: any[]): void;
public toJSON(): PieceEventJSON;
private _run(param: any): void;
}
export abstract class Extendable extends Piece {
public constructor(client: KlasaClient, store: ExtendableStore, file: string, core: boolean, options?: ExtendableOptions);
public appliesTo: string[];
public target: boolean;
public abstract extend(...params: any[]): any;
public toJSON(): PieceExtendableJSON;
}
export abstract class Finalizer extends Piece {
public abstract run(msg: KlasaMessage, mes: KlasaMessage, start: Stopwatch): void;
public toJSON(): PieceFinalizerJSON;
}
export abstract class Inhibitor extends Piece {
public constructor(client: KlasaClient, store: InhibitorStore, file: string, core: boolean, options?: InhibitorOptions);
public spamProtection: boolean;
public abstract run(msg: KlasaMessage, cmd: Command): Promise<void | string>;
public toJSON(): PieceInhibitorJSON;
}
export abstract class Language extends Piece {
public language: { [key: string]: any };
public get(term: string, ...args: any[]): any;
public toJSON(): PieceLanguageJSON;
}
export abstract class Monitor extends Piece {
public constructor(client: KlasaClient, store: MonitorStore, file: string, core: boolean, options?: MonitorOptions);
public ignoreBots: boolean;
public ignoreSelf: boolean;
public ignoreOthers: boolean;
public ignoreWebhooks: boolean;
public abstract run(msg: KlasaMessage): void;
public shouldRun(msg: KlasaMessage): boolean;
public toJSON(): PieceMonitorJSON;
}
export abstract class Provider extends Piece {
public constructor(client: KlasaClient, store: ProviderStore, file: string, core: boolean, options?: ProviderOptions);
public cache: boolean;
public sql: boolean;
public abstract hasTable(table: string): Promise<boolean>;
public abstract createTable(table: string): Promise<any>;
public abstract deleteTable(table: string): Promise<any>;
public abstract getAll<T>(table: string): Promise<T[]>;
public abstract getKeys(table: string): Promise<string[]>;
public abstract get<T>(table: string, entry: string): Promise<T>;
public abstract has(table: string, entry: string): Promise<boolean>;
public abstract updateValue(table: string, path: string, newValue: any): Promise<any>;
public abstract removeValue(table: string, path: string): Promise<any>;
public abstract create(table: string, entry: string, data: any): Promise<any>;
public abstract update(table: string, entry: string, data: any): Promise<any>;
public abstract replace(table: string, entry: string, data: any): Promise<any>;
public abstract delete(table: string, entry: string): Promise<any>;
public shutdown(): Promise<void>;
public toJSON(): PieceProviderJSON;
}
export abstract class Task extends Piece {
public abstract run(data: any): Promise<void>;
public toJSON(): PieceTaskJSON;
}
//#endregion Pieces
//#region Stores
export class Store<K, V> extends Collection<K, V> {
public readonly client: KlasaClient;
public readonly name: string;
public readonly holds: V;
public readonly coreDir: string;
public readonly userDir: string;
public init(): Promise<any[]>;
public load(file: string | string[], core?: boolean): Piece;
public loadAll(): Promise<number>;
public resolve(name: Piece | string): Piece;
public toString(): string;
}
export class CommandStore extends Store<string, Command> {
public constructor(client: KlasaClient);
public aliases: Collection<string, Command>;
public get(name: string): Command;
public has(name: string): boolean;
public set(key: string, value: Command): this;
public set(command: Command): Command;
public delete(name: Command | string): boolean;
public clear(): void;
}
export class EventStore extends Store<string, Event> {
public constructor(client: KlasaClient);
public clear(): void;
public delete(name: Event | string): boolean;
public set(key: string, value: Event): this;
public set(event: Event): Event;
}
export class ExtendableStore extends Store<string, Extendable> {
public constructor(client: KlasaClient);
public delete(name: Extendable | string): boolean;
public clear(): void;
public set(key: string, value: Extendable): this;
public set(extendable: Extendable): Extendable;
}
export class FinalizerStore extends Store<string, Finalizer> {
public constructor(client: KlasaClient);
public run(msg: KlasaMessage, mes: KlasaMessage, start: number): Promise<void>;
}
export class InhibitorStore extends Store<string, Inhibitor> {
public constructor(client: KlasaClient);
public run(msg: KlasaMessage, cmd: Command, selective: boolean): Promise<void>;
}
export class LanguageStore extends Store<string, Language> {
public constructor(client: KlasaClient);
public readonly default: Language;
}
export class MonitorStore extends Store<string, Monitor> {
public constructor(client: KlasaClient);
public run(msg: KlasaMessage): Promise<void>;
}
export class ProviderStore extends Store<string, Provider> {
public constructor(client: KlasaClient);
public readonly default: Provider;
public clear(): void;
public delete(name: Provider | string): boolean;
}
export class TaskStore extends Store<string, Task> {
public constructor(client: KlasaClient);
}
//#endregion Stores
//#region Usage
export class CommandPrompt extends TextPrompt {
public constructor(msg: KlasaMessage, usage: CommandUsage, options: TextPromptOptions);
private typing: boolean;
public run(): Promise<any[]>;
}
export class CommandUsage extends Usage {
public constructor(client: KlasaClient, command: Command);
public names: string[];
public commands: string;
public nearlyFullUsage: string;
public createPrompt(msg: KlasaMessage, options?: TextPromptOptions): CommandPrompt;
public fullUsage(msg: KlasaMessage): string;
public toString(): string;
}
export class Possible {
public constructor([match, name, type, min, max, regex, flags]: [string, string, string, string, string, string, string]);
public name: string;
public type: string;
public min: number;
public max: number;
public regex: RegExp;
private static resolveLimit(limit: string, type: string): number;
}
export class Tag {
public constructor(members: string, count: number, required: boolean);
public required: number;
public possibles: Possible[];
public response: string | ((msg: KlasaMessage) => string);
private register(name: string, response: ArgResolverCustomMethod): boolean;
private static pattern: RegExp;
private static parseMembers(members: string, count: number): Possible[];
private static parseTrueMembers(members: string): string[];
}
export class TextPrompt {
public constructor(msg: KlasaMessage, usage: Usage, options: TextPromptOptions);
public readonly client: KlasaClient;
public message: KlasaMessage;
public usage: Usage | CommandUsage;
public reprompted: boolean;
public flags: object;
public args: string[];
public params: any[];
public promptTime: number;
public promptLimit: number;
public quotedStringSupport: boolean;
private _repeat: boolean;
private _required: number;
private _prompted: number;
private _currentUsage: Tag;
public run(prompt: string): Promise<any[]>;
private reprompt(prompt: string): Promise<any[]>;
private repeatingPrompt(): Promise<any[]>;
private validateArgs(): Promise<any[]>;
private multiPossibles(index: number): Promise<any[]>;
private pushParam(param: any): any[];
private handleError(err: string): Promise<any[]>;
private finalize(): any[];
private _setup(original: string): void;
private static getFlags(content: string, delim: string): { content: string; flags: object };
private static getArgs(content: string, delim: string): string[];
private static getQuotedStringArgs(content: string, delim: string): string[];
public static readonly flagRegex: RegExp;
}
export class Usage {
public constructor(client: KlasaClient, usageString: string, usageDelim: string);
public readonly client: KlasaClient;
public deliminatedUsage: string;
public usageString: string;
public usageDelim: string;
public parsedUsage: Tag[];
public customResolvers: { [K: string]: ArgResolverCustomMethod };