forked from saanuregh/discord.js-pagination
-
Notifications
You must be signed in to change notification settings - Fork 8
/
index.d.ts
46 lines (38 loc) · 1.71 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
import { Collection, EmojiIdentifierResolvable, Interaction, Message,
MessageEmbed,MessageReaction, ReactionCollector, ReactionCollectorOptions,
Snowflake, User } from "discord.js";
interface PageResolverParameters {
paginatedEmbedMessage?: MessageEmbed;
pages?: MessageEmbed[];
emojiList?: string[];
currentPageIndex?: number;
reaction?: MessageReaction;
}
interface CollectorFilterParameters {
reaction?: MessageReaction;
user?: User;
emojiList: string[];
}
interface BaseHandlerParameters {
receivedMessage?: Interaction | Message;
paginatedEmbedMessage?: MessageEmbed;
}
interface CollectErrorHandlerParameters extends BaseHandlerParameters {
error?: Error;
reactionCollector?: ReactionCollector;
}
interface CollectEndHandlerParameters extends BaseHandlerParameters {
collected?: Collection<Snowflake, MessageReaction>;
reason?: string;
}
interface PaginationOptions extends ReactionCollectorOptions {
emojiList?: EmojiIdentifierResolvable[];
footerResolver?(pageIndex: number, pagesLength: number): string;
sendMessage?(receivedMessage: Interaction | Message, pageEmbed: MessageEmbed): Promise<Message>;
collectorFilter?(collectorFilterParameters?: CollectorFilterParameters): boolean | Promise<boolean>;
pageResolver?(pageResolverParameters?: PageResolverParameters): number | Promise<number>;
collectErrorHandler?(collectErrorHandlerParameters?: CollectErrorHandlerParameters): void | Promise<void>;
collectorEndHandler?(collectorEndHandlerParameters?: CollectEndHandlerParameters): void | Promise<void>;
}
declare function paginationEmbed(receivedMessage: Interaction | Message, pages: MessageEmbed[], paginationOptions?: PaginationOptions): Promise<Message>;
export = paginationEmbed;