@@ -26,9 +26,16 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
26
26
page : number ;
27
27
/** The time for awaiting a user action before timeout in ms. Default: `30000` */
28
28
timeout : number ;
29
- /** The emojis used for navigation emojis. */
29
+ /**
30
+ * The emojis used for navigation emojis.
31
+ * Navigation emojis are the default message reactions for navigating through the pagination.
32
+ */
30
33
navigationEmojis : INavigationEmojis ;
31
- /** The emojis used for function emojis. */
34
+ /**
35
+ * The emojis used for function emojis.
36
+ * Function emojis are user-customised message reactions
37
+ * for modifying the current instance of the pagination such as modifying embed texts, stopping the pagination, etc.
38
+ */
32
39
functionEmojis : IFunctionEmoji < Element > ;
33
40
/**
34
41
* The disabled navigation emojis.
@@ -60,7 +67,7 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
60
67
* ### Example
61
68
* ```js
62
69
* <PaginationEmbed>.addFunctionEmoji('🅱', (_, instance) => {
63
- * const field = instance.fields[0];
70
+ * const field = instance.embed. fields[0];
64
71
*
65
72
* if (field.name.includes('🅱'))
66
73
* field.name = 'Name';
@@ -126,7 +133,7 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
126
133
* ```js
127
134
* <PaginationEmbed>.setFunctionEmojis({
128
135
* '🔄': (user, instance) => {
129
- * const field = instance.fields[0];
136
+ * const field = instance.embed. fields[0];
130
137
*
131
138
* if (field.name === 'Name')
132
139
* field.name = user.tag;
@@ -199,8 +206,8 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
199
206
/** Awaits the reaction from the user(s). */
200
207
protected _awaitResponse ( ) : Promise < void > ;
201
208
/**
202
- * Only used for _awaitResponse:
203
- * Deletes the client's message, and emites either error or finish depending on the passed parameters.
209
+ * Only used for ` _awaitResponse` :
210
+ * Deletes the client's message, and emits either ` error` or ` finish` event depending on the passed parameters.
204
211
* @param err The error object.
205
212
* @param clientMessage The client's message.
206
213
* @param expired Whether the clean up is for `expired` event.
@@ -222,6 +229,11 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
222
229
* @event
223
230
*/
224
231
on ( event : 'finish' , listener : ListenerUser ) : this;
232
+ /**
233
+ * Emitted when the page number is updated.
234
+ * @event
235
+ */
236
+ on ( event : 'pageUpdate' , listener : ( ) => void ) : this;
225
237
/**
226
238
* Emitted upon a user reacting on the instance.
227
239
* @event
@@ -240,7 +252,7 @@ export declare class PaginationEmbed<Element> extends EventEmitter {
240
252
/** @event */
241
253
once ( event : 'finish' , listener : ListenerUser ) : this;
242
254
/** @event */
243
- once ( event : 'start' | 'expire' , listener : ( ) => void ) : this;
255
+ once ( event : 'start' | 'expire' | 'pageUpdate' , listener : ( ) => void ) : this;
244
256
/** @event */
245
257
once ( event : 'react' , listener : ListenerReact ) : this;
246
258
/** @event */
0 commit comments