@acegoal07/discordjs-pagination
Version:
A simple pagination for Discord.js
100 lines • 3.33 kB
TypeScript
export class Pagination {
paginationInfo: PaginationInfo;
options: PaginationOptions;
/**
* Sets the used portal for the pagination
* @param {import("discord.js").Message | import("discord.js").Interaction} portal
* @param {{ interaction_ephemeral?: Boolean }} settings
* @returns {exports.Pagination}
*/
setPortal(portal: any | any, settings?: {
interaction_ephemeral?: boolean;
}): Pagination;
/**
* Sets the button list for the pagination
* @param {import("discord.js").ButtonBuilder[]} buttonList
* @returns {exports.Pagination}
*/
setButtonList(buttonList: any[]): Pagination;
/**
* Sets the page list for the pagination
* @param {import("discord.js").EmbedBuilder[]} pageList
* @returns {exports.Pagination}
*/
setPageList(pageList: any[]): Pagination;
/**
* Sets the image list for the pagination
* @param {import("discord.js").AttachmentBuilder[]} imageList
* @returns {exports.Pagination}
*/
setImageList(imageList: any[]): Pagination;
/**
* Sets the attachment list for the pagination
* @param {import("discord.js").AttachmentBuilder[]} attachmentList
* @returns {exports.Pagination}
*/
setAttachmentList(attachmentList: any[]): Pagination;
/**
* Runs the pagination
* @returns {exports.Pagination}
*/
paginate(): Pagination;
/**
* Sets the timeout for the pagination in milliseconds
* @param {Number} timeout
* @returns {exports.Pagination}
*/
setTimeout(timeout: number): Pagination;
/**
* Enables and customizes a progress bar for your pagination
* @param {{ slider?: String, bar?: String }} settings
* @returns {exports.Pagination}
*/
setProgressBar({ slider, bar }?: {
slider?: string;
bar?: string;
}): Pagination;
/**
* Enables replyMessage for your pagination
* @returns {exports.Pagination}
*/
enableReplyMessage(): Pagination;
/**
* Enables autoDelete for your pagination
* @returns {exports.Pagination}
*/
enableAutoDelete(): Pagination;
/**
* Enables privateReply for your pagination
* @returns {exports.Pagination}
*/
enablePrivateReply(): Pagination;
/**
* Enables authorIndependent for your pagination
* @returns {exports.Pagination}
*/
enableAuthorIndependent(): Pagination;
/**
* Enables autoButton for your pagination
* @param {Boolean} deleteButton
* @returns {exports.Pagination}
*/
enableAutoButton(deleteButton?: boolean): Pagination;
/**
* Enables selectMenu for your pagination
* @param {{ customLabels?: Array<String>, useTitles?: Boolean }} settings
* @returns {exports.Pagination}
*/
enableSelectMenu({ customLabels, useTitles }?: {
customLabels?: Array<string>;
useTitles?: boolean;
}): Pagination;
/**
* Disables the buttons being disabled and reapplied to the pagination after the timeout ends
* @returns {exports.Pagination}
*/
disableDisabledButtons(): Pagination;
}
import { PaginationInfo } from "./util/typedef/paginationInfo";
import { PaginationOptions } from "./util/typedef/paginationOptions";
//# sourceMappingURL=index.d.ts.map