diff --git a/.npmignore b/.npmignore index 810001f..80bc7b9 100644 --- a/.npmignore +++ b/.npmignore @@ -1,3 +1,4 @@ +.dccache .vscode .eslintrc.json tsconfig.json diff --git a/docs/assets/search.js b/docs/assets/search.js index 0862046..8ab1af1 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":256,"name":"Options","url":"interfaces/Options.html","classes":"tsd-kind-interface"},{"id":1,"kind":1024,"name":"limit","url":"interfaces/Options.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":2,"kind":1024,"name":"idle","url":"interfaces/Options.html#idle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":3,"kind":1024,"name":"ephemeral","url":"interfaces/Options.html#ephemeral","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":4,"kind":1024,"name":"prevDescription","url":"interfaces/Options.html#prevDescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":5,"kind":1024,"name":"postDescription","url":"interfaces/Options.html#postDescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":6,"kind":1024,"name":"attachments","url":"interfaces/Options.html#attachments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":7,"kind":1024,"name":"buttonStyle","url":"interfaces/Options.html#buttonStyle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":8,"kind":1024,"name":"firstEmoji","url":"interfaces/Options.html#firstEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":9,"kind":1024,"name":"prevEmoji","url":"interfaces/Options.html#prevEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":10,"kind":1024,"name":"nextEmoji","url":"interfaces/Options.html#nextEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":11,"kind":1024,"name":"lastEmoji","url":"interfaces/Options.html#lastEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":12,"kind":256,"name":"EmojiOptions","url":"interfaces/EmojiOptions.html","classes":"tsd-kind-interface"},{"id":13,"kind":1024,"name":"firstEmoji","url":"interfaces/EmojiOptions.html#firstEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":14,"kind":1024,"name":"prevEmoji","url":"interfaces/EmojiOptions.html#prevEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":15,"kind":1024,"name":"nextEmoji","url":"interfaces/EmojiOptions.html#nextEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":16,"kind":1024,"name":"lastEmoji","url":"interfaces/EmojiOptions.html#lastEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":17,"kind":256,"name":"ButtonOptions","url":"interfaces/ButtonOptions.html","classes":"tsd-kind-interface"},{"id":18,"kind":1024,"name":"emoji","url":"interfaces/ButtonOptions.html#emoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":19,"kind":1024,"name":"label","url":"interfaces/ButtonOptions.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":20,"kind":1024,"name":"style","url":"interfaces/ButtonOptions.html#style","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":21,"kind":256,"name":"ButtonOptionsRequired","url":"interfaces/ButtonOptionsRequired.html","classes":"tsd-kind-interface"},{"id":22,"kind":1024,"name":"emoji","url":"interfaces/ButtonOptionsRequired.html#emoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":23,"kind":1024,"name":"label","url":"interfaces/ButtonOptionsRequired.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":24,"kind":1024,"name":"style","url":"interfaces/ButtonOptionsRequired.html#style","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":25,"kind":256,"name":"ButtonsOptions","url":"interfaces/ButtonsOptions.html","classes":"tsd-kind-interface"},{"id":26,"kind":1024,"name":"first","url":"interfaces/ButtonsOptions.html#first","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":27,"kind":1024,"name":"prev","url":"interfaces/ButtonsOptions.html#prev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":28,"kind":1024,"name":"next","url":"interfaces/ButtonsOptions.html#next","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":29,"kind":1024,"name":"last","url":"interfaces/ButtonsOptions.html#last","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":30,"kind":256,"name":"ButtonsOptionsRequired","url":"interfaces/ButtonsOptionsRequired.html","classes":"tsd-kind-interface"},{"id":31,"kind":1024,"name":"first","url":"interfaces/ButtonsOptionsRequired.html#first","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":32,"kind":1024,"name":"prev","url":"interfaces/ButtonsOptionsRequired.html#prev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":33,"kind":1024,"name":"next","url":"interfaces/ButtonsOptionsRequired.html#next","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":34,"kind":1024,"name":"last","url":"interfaces/ButtonsOptionsRequired.html#last","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":35,"kind":4194304,"name":"ButtonStyle","url":"modules.html#ButtonStyle","classes":"tsd-kind-type-alias"},{"id":36,"kind":128,"name":"Pagination","url":"classes/Pagination.html","classes":"tsd-kind-class"},{"id":37,"kind":512,"name":"constructor","url":"classes/Pagination.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"Pagination"},{"id":38,"kind":1024,"name":"interaction","url":"classes/Pagination.html#interaction","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":39,"kind":1024,"name":"images","url":"classes/Pagination.html#images","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":40,"kind":1024,"name":"descriptions","url":"classes/Pagination.html#descriptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":41,"kind":1024,"name":"actionRows","url":"classes/Pagination.html#actionRows","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":42,"kind":1024,"name":"payloads","url":"classes/Pagination.html#payloads","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":43,"kind":1024,"name":"totalEntry","url":"classes/Pagination.html#totalEntry","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":44,"kind":1024,"name":"buttonInfo","url":"classes/Pagination.html#buttonInfo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":45,"kind":1024,"name":"limit","url":"classes/Pagination.html#limit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":46,"kind":1024,"name":"idle","url":"classes/Pagination.html#idle","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":47,"kind":1024,"name":"ephemeral","url":"classes/Pagination.html#ephemeral","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":48,"kind":1024,"name":"prevDescription","url":"classes/Pagination.html#prevDescription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":49,"kind":1024,"name":"postDescription","url":"classes/Pagination.html#postDescription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":50,"kind":1024,"name":"attachments","url":"classes/Pagination.html#attachments","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":51,"kind":1024,"name":"currentPage","url":"classes/Pagination.html#currentPage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":52,"kind":1024,"name":"customFooter","url":"classes/Pagination.html#customFooter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":53,"kind":1024,"name":"fieldPaginate","url":"classes/Pagination.html#fieldPaginate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":54,"kind":1024,"name":"buttons","url":"classes/Pagination.html#buttons","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":55,"kind":65536,"name":"__type","url":"classes/Pagination.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Pagination"},{"id":56,"kind":1024,"name":"first","url":"classes/Pagination.html#__type.first","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":57,"kind":1024,"name":"prev","url":"classes/Pagination.html#__type.prev","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":58,"kind":1024,"name":"next","url":"classes/Pagination.html#__type.next","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":59,"kind":1024,"name":"last","url":"classes/Pagination.html#__type.last","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":60,"kind":1024,"name":"mainActionRow","url":"classes/Pagination.html#mainActionRow","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":61,"kind":1024,"name":"rawFooter","url":"classes/Pagination.html#rawFooter","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":62,"kind":2048,"name":"setOptions","url":"classes/Pagination.html#setOptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":63,"kind":2048,"name":"setImages","url":"classes/Pagination.html#setImages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":64,"kind":2048,"name":"addImage","url":"classes/Pagination.html#addImage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":65,"kind":2048,"name":"addImages","url":"classes/Pagination.html#addImages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":66,"kind":2048,"name":"setDescriptions","url":"classes/Pagination.html#setDescriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":67,"kind":2048,"name":"addDescription","url":"classes/Pagination.html#addDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":68,"kind":2048,"name":"addDescriptions","url":"classes/Pagination.html#addDescriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":69,"kind":2048,"name":"paginateFields","url":"classes/Pagination.html#paginateFields","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":70,"kind":2048,"name":"setIdle","url":"classes/Pagination.html#setIdle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":71,"kind":2048,"name":"setEphemeral","url":"classes/Pagination.html#setEphemeral","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":72,"kind":2048,"name":"setLimit","url":"classes/Pagination.html#setLimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":73,"kind":2048,"name":"setPrevDescription","url":"classes/Pagination.html#setPrevDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":74,"kind":2048,"name":"setPostDescription","url":"classes/Pagination.html#setPostDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":75,"kind":2048,"name":"setEmojis","url":"classes/Pagination.html#setEmojis","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":76,"kind":2048,"name":"setStyle","url":"classes/Pagination.html#setStyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":77,"kind":2048,"name":"setButtonAppearance","url":"classes/Pagination.html#setButtonAppearance","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":78,"kind":2048,"name":"addActionRows","url":"classes/Pagination.html#addActionRows","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":79,"kind":2048,"name":"setAttachments","url":"classes/Pagination.html#setAttachments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":80,"kind":2048,"name":"addAttachment","url":"classes/Pagination.html#addAttachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":81,"kind":2048,"name":"addAttachments","url":"classes/Pagination.html#addAttachments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":82,"kind":2048,"name":"readyActionRows","url":"classes/Pagination.html#readyActionRows","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":83,"kind":2048,"name":"readyPayloads","url":"classes/Pagination.html#readyPayloads","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":84,"kind":2048,"name":"goToPage","url":"classes/Pagination.html#goToPage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":85,"kind":2048,"name":"goFirst","url":"classes/Pagination.html#goFirst","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":86,"kind":2048,"name":"goPrev","url":"classes/Pagination.html#goPrev","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":87,"kind":2048,"name":"goNext","url":"classes/Pagination.html#goNext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":88,"kind":2048,"name":"goLast","url":"classes/Pagination.html#goLast","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":89,"kind":2048,"name":"paginate","url":"classes/Pagination.html#paginate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":90,"kind":2048,"name":"ready","url":"classes/Pagination.html#ready","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":91,"kind":2048,"name":"render","url":"classes/Pagination.html#render","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":92,"kind":2048,"name":"reply","url":"classes/Pagination.html#reply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":93,"kind":2048,"name":"followUp","url":"classes/Pagination.html#followUp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":94,"kind":2048,"name":"editReply","url":"classes/Pagination.html#editReply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":95,"kind":2048,"name":"update","url":"classes/Pagination.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":96,"kind":2048,"name":"send","url":"classes/Pagination.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,20.592]],["parent/0",[]],["name/1",[1,36.687]],["parent/1",[0,1.986]],["name/2",[2,36.687]],["parent/2",[0,1.986]],["name/3",[3,36.687]],["parent/3",[0,1.986]],["name/4",[4,36.687]],["parent/4",[0,1.986]],["name/5",[5,36.687]],["parent/5",[0,1.986]],["name/6",[6,36.687]],["parent/6",[0,1.986]],["name/7",[7,36.687]],["parent/7",[0,1.986]],["name/8",[8,36.687]],["parent/8",[0,1.986]],["name/9",[9,36.687]],["parent/9",[0,1.986]],["name/10",[10,36.687]],["parent/10",[0,1.986]],["name/11",[11,36.687]],["parent/11",[0,1.986]],["name/12",[12,28.802]],["parent/12",[]],["name/13",[8,36.687]],["parent/13",[12,2.778]],["name/14",[9,36.687]],["parent/14",[12,2.778]],["name/15",[10,36.687]],["parent/15",[12,2.778]],["name/16",[11,36.687]],["parent/16",[12,2.778]],["name/17",[13,30.809]],["parent/17",[]],["name/18",[14,36.687]],["parent/18",[13,2.972]],["name/19",[15,36.687]],["parent/19",[13,2.972]],["name/20",[16,36.687]],["parent/20",[13,2.972]],["name/21",[17,30.809]],["parent/21",[]],["name/22",[14,36.687]],["parent/22",[17,2.972]],["name/23",[15,36.687]],["parent/23",[17,2.972]],["name/24",[16,36.687]],["parent/24",[17,2.972]],["name/25",[18,28.802]],["parent/25",[]],["name/26",[19,33.322]],["parent/26",[18,2.778]],["name/27",[20,33.322]],["parent/27",[18,2.778]],["name/28",[21,33.322]],["parent/28",[18,2.778]],["name/29",[22,33.322]],["parent/29",[18,2.778]],["name/30",[23,28.802]],["parent/30",[]],["name/31",[19,33.322]],["parent/31",[23,2.778]],["name/32",[20,33.322]],["parent/32",[23,2.778]],["name/33",[21,33.322]],["parent/33",[23,2.778]],["name/34",[22,33.322]],["parent/34",[23,2.778]],["name/35",[7,36.687]],["parent/35",[]],["name/36",[24,5.332]],["parent/36",[]],["name/37",[25,41.795]],["parent/37",[24,0.514]],["name/38",[26,41.795]],["parent/38",[24,0.514]],["name/39",[27,41.795]],["parent/39",[24,0.514]],["name/40",[28,41.795]],["parent/40",[24,0.514]],["name/41",[29,41.795]],["parent/41",[24,0.514]],["name/42",[30,41.795]],["parent/42",[24,0.514]],["name/43",[31,41.795]],["parent/43",[24,0.514]],["name/44",[32,41.795]],["parent/44",[24,0.514]],["name/45",[1,36.687]],["parent/45",[24,0.514]],["name/46",[2,36.687]],["parent/46",[24,0.514]],["name/47",[3,36.687]],["parent/47",[24,0.514]],["name/48",[4,36.687]],["parent/48",[24,0.514]],["name/49",[5,36.687]],["parent/49",[24,0.514]],["name/50",[6,36.687]],["parent/50",[24,0.514]],["name/51",[33,41.795]],["parent/51",[24,0.514]],["name/52",[34,41.795]],["parent/52",[24,0.514]],["name/53",[35,41.795]],["parent/53",[24,0.514]],["name/54",[36,41.795]],["parent/54",[24,0.514]],["name/55",[37,41.795]],["parent/55",[24,0.514]],["name/56",[19,33.322]],["parent/56",[38,2.972]],["name/57",[20,33.322]],["parent/57",[38,2.972]],["name/58",[21,33.322]],["parent/58",[38,2.972]],["name/59",[22,33.322]],["parent/59",[38,2.972]],["name/60",[39,41.795]],["parent/60",[24,0.514]],["name/61",[40,41.795]],["parent/61",[24,0.514]],["name/62",[41,41.795]],["parent/62",[24,0.514]],["name/63",[42,41.795]],["parent/63",[24,0.514]],["name/64",[43,41.795]],["parent/64",[24,0.514]],["name/65",[44,41.795]],["parent/65",[24,0.514]],["name/66",[45,41.795]],["parent/66",[24,0.514]],["name/67",[46,41.795]],["parent/67",[24,0.514]],["name/68",[47,41.795]],["parent/68",[24,0.514]],["name/69",[48,41.795]],["parent/69",[24,0.514]],["name/70",[49,41.795]],["parent/70",[24,0.514]],["name/71",[50,41.795]],["parent/71",[24,0.514]],["name/72",[51,41.795]],["parent/72",[24,0.514]],["name/73",[52,41.795]],["parent/73",[24,0.514]],["name/74",[53,41.795]],["parent/74",[24,0.514]],["name/75",[54,41.795]],["parent/75",[24,0.514]],["name/76",[55,41.795]],["parent/76",[24,0.514]],["name/77",[56,41.795]],["parent/77",[24,0.514]],["name/78",[57,41.795]],["parent/78",[24,0.514]],["name/79",[58,41.795]],["parent/79",[24,0.514]],["name/80",[59,41.795]],["parent/80",[24,0.514]],["name/81",[60,41.795]],["parent/81",[24,0.514]],["name/82",[61,41.795]],["parent/82",[24,0.514]],["name/83",[62,41.795]],["parent/83",[24,0.514]],["name/84",[63,41.795]],["parent/84",[24,0.514]],["name/85",[64,41.795]],["parent/85",[24,0.514]],["name/86",[65,41.795]],["parent/86",[24,0.514]],["name/87",[66,41.795]],["parent/87",[24,0.514]],["name/88",[67,41.795]],["parent/88",[24,0.514]],["name/89",[68,41.795]],["parent/89",[24,0.514]],["name/90",[69,41.795]],["parent/90",[24,0.514]],["name/91",[70,41.795]],["parent/91",[24,0.514]],["name/92",[71,41.795]],["parent/92",[24,0.514]],["name/93",[72,41.795]],["parent/93",[24,0.514]],["name/94",[73,41.795]],["parent/94",[24,0.514]],["name/95",[74,41.795]],["parent/95",[24,0.514]],["name/96",[75,41.795]],["parent/96",[24,0.514]]],"invertedIndex":[["__type",{"_index":37,"name":{"55":{}},"parent":{}}],["actionrows",{"_index":29,"name":{"41":{}},"parent":{}}],["addactionrows",{"_index":57,"name":{"78":{}},"parent":{}}],["addattachment",{"_index":59,"name":{"80":{}},"parent":{}}],["addattachments",{"_index":60,"name":{"81":{}},"parent":{}}],["adddescription",{"_index":46,"name":{"67":{}},"parent":{}}],["adddescriptions",{"_index":47,"name":{"68":{}},"parent":{}}],["addimage",{"_index":43,"name":{"64":{}},"parent":{}}],["addimages",{"_index":44,"name":{"65":{}},"parent":{}}],["attachments",{"_index":6,"name":{"6":{},"50":{}},"parent":{}}],["buttoninfo",{"_index":32,"name":{"44":{}},"parent":{}}],["buttonoptions",{"_index":13,"name":{"17":{}},"parent":{"18":{},"19":{},"20":{}}}],["buttonoptionsrequired",{"_index":17,"name":{"21":{}},"parent":{"22":{},"23":{},"24":{}}}],["buttons",{"_index":36,"name":{"54":{}},"parent":{}}],["buttonsoptions",{"_index":18,"name":{"25":{}},"parent":{"26":{},"27":{},"28":{},"29":{}}}],["buttonsoptionsrequired",{"_index":23,"name":{"30":{}},"parent":{"31":{},"32":{},"33":{},"34":{}}}],["buttonstyle",{"_index":7,"name":{"7":{},"35":{}},"parent":{}}],["constructor",{"_index":25,"name":{"37":{}},"parent":{}}],["currentpage",{"_index":33,"name":{"51":{}},"parent":{}}],["customfooter",{"_index":34,"name":{"52":{}},"parent":{}}],["descriptions",{"_index":28,"name":{"40":{}},"parent":{}}],["editreply",{"_index":73,"name":{"94":{}},"parent":{}}],["emoji",{"_index":14,"name":{"18":{},"22":{}},"parent":{}}],["emojioptions",{"_index":12,"name":{"12":{}},"parent":{"13":{},"14":{},"15":{},"16":{}}}],["ephemeral",{"_index":3,"name":{"3":{},"47":{}},"parent":{}}],["fieldpaginate",{"_index":35,"name":{"53":{}},"parent":{}}],["first",{"_index":19,"name":{"26":{},"31":{},"56":{}},"parent":{}}],["firstemoji",{"_index":8,"name":{"8":{},"13":{}},"parent":{}}],["followup",{"_index":72,"name":{"93":{}},"parent":{}}],["gofirst",{"_index":64,"name":{"85":{}},"parent":{}}],["golast",{"_index":67,"name":{"88":{}},"parent":{}}],["gonext",{"_index":66,"name":{"87":{}},"parent":{}}],["goprev",{"_index":65,"name":{"86":{}},"parent":{}}],["gotopage",{"_index":63,"name":{"84":{}},"parent":{}}],["idle",{"_index":2,"name":{"2":{},"46":{}},"parent":{}}],["images",{"_index":27,"name":{"39":{}},"parent":{}}],["interaction",{"_index":26,"name":{"38":{}},"parent":{}}],["label",{"_index":15,"name":{"19":{},"23":{}},"parent":{}}],["last",{"_index":22,"name":{"29":{},"34":{},"59":{}},"parent":{}}],["lastemoji",{"_index":11,"name":{"11":{},"16":{}},"parent":{}}],["limit",{"_index":1,"name":{"1":{},"45":{}},"parent":{}}],["mainactionrow",{"_index":39,"name":{"60":{}},"parent":{}}],["next",{"_index":21,"name":{"28":{},"33":{},"58":{}},"parent":{}}],["nextemoji",{"_index":10,"name":{"10":{},"15":{}},"parent":{}}],["options",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{}}}],["paginate",{"_index":68,"name":{"89":{}},"parent":{}}],["paginatefields",{"_index":48,"name":{"69":{}},"parent":{}}],["pagination",{"_index":24,"name":{"36":{}},"parent":{"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"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":{}}}],["pagination.__type",{"_index":38,"name":{},"parent":{"56":{},"57":{},"58":{},"59":{}}}],["payloads",{"_index":30,"name":{"42":{}},"parent":{}}],["postdescription",{"_index":5,"name":{"5":{},"49":{}},"parent":{}}],["prev",{"_index":20,"name":{"27":{},"32":{},"57":{}},"parent":{}}],["prevdescription",{"_index":4,"name":{"4":{},"48":{}},"parent":{}}],["prevemoji",{"_index":9,"name":{"9":{},"14":{}},"parent":{}}],["rawfooter",{"_index":40,"name":{"61":{}},"parent":{}}],["ready",{"_index":69,"name":{"90":{}},"parent":{}}],["readyactionrows",{"_index":61,"name":{"82":{}},"parent":{}}],["readypayloads",{"_index":62,"name":{"83":{}},"parent":{}}],["render",{"_index":70,"name":{"91":{}},"parent":{}}],["reply",{"_index":71,"name":{"92":{}},"parent":{}}],["send",{"_index":75,"name":{"96":{}},"parent":{}}],["setattachments",{"_index":58,"name":{"79":{}},"parent":{}}],["setbuttonappearance",{"_index":56,"name":{"77":{}},"parent":{}}],["setdescriptions",{"_index":45,"name":{"66":{}},"parent":{}}],["setemojis",{"_index":54,"name":{"75":{}},"parent":{}}],["setephemeral",{"_index":50,"name":{"71":{}},"parent":{}}],["setidle",{"_index":49,"name":{"70":{}},"parent":{}}],["setimages",{"_index":42,"name":{"63":{}},"parent":{}}],["setlimit",{"_index":51,"name":{"72":{}},"parent":{}}],["setoptions",{"_index":41,"name":{"62":{}},"parent":{}}],["setpostdescription",{"_index":53,"name":{"74":{}},"parent":{}}],["setprevdescription",{"_index":52,"name":{"73":{}},"parent":{}}],["setstyle",{"_index":55,"name":{"76":{}},"parent":{}}],["style",{"_index":16,"name":{"20":{},"24":{}},"parent":{}}],["totalentry",{"_index":31,"name":{"43":{}},"parent":{}}],["update",{"_index":74,"name":{"95":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file +window.searchData = {"kinds":{"128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":256,"name":"Options","url":"interfaces/Options.html","classes":"tsd-kind-interface"},{"id":1,"kind":1024,"name":"limit","url":"interfaces/Options.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":2,"kind":1024,"name":"idle","url":"interfaces/Options.html#idle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":3,"kind":1024,"name":"ephemeral","url":"interfaces/Options.html#ephemeral","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":4,"kind":1024,"name":"prevDescription","url":"interfaces/Options.html#prevDescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":5,"kind":1024,"name":"postDescription","url":"interfaces/Options.html#postDescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":6,"kind":1024,"name":"attachments","url":"interfaces/Options.html#attachments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":7,"kind":1024,"name":"buttonStyle","url":"interfaces/Options.html#buttonStyle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Options"},{"id":8,"kind":1024,"name":"firstEmoji","url":"interfaces/Options.html#firstEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":9,"kind":1024,"name":"prevEmoji","url":"interfaces/Options.html#prevEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":10,"kind":1024,"name":"nextEmoji","url":"interfaces/Options.html#nextEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":11,"kind":1024,"name":"lastEmoji","url":"interfaces/Options.html#lastEmoji","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Options"},{"id":12,"kind":256,"name":"EmojiOptions","url":"interfaces/EmojiOptions.html","classes":"tsd-kind-interface"},{"id":13,"kind":1024,"name":"firstEmoji","url":"interfaces/EmojiOptions.html#firstEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":14,"kind":1024,"name":"prevEmoji","url":"interfaces/EmojiOptions.html#prevEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":15,"kind":1024,"name":"nextEmoji","url":"interfaces/EmojiOptions.html#nextEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":16,"kind":1024,"name":"lastEmoji","url":"interfaces/EmojiOptions.html#lastEmoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"EmojiOptions"},{"id":17,"kind":256,"name":"ButtonOptions","url":"interfaces/ButtonOptions.html","classes":"tsd-kind-interface"},{"id":18,"kind":1024,"name":"emoji","url":"interfaces/ButtonOptions.html#emoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":19,"kind":1024,"name":"label","url":"interfaces/ButtonOptions.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":20,"kind":1024,"name":"style","url":"interfaces/ButtonOptions.html#style","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptions"},{"id":21,"kind":256,"name":"ButtonOptionsRequired","url":"interfaces/ButtonOptionsRequired.html","classes":"tsd-kind-interface"},{"id":22,"kind":1024,"name":"emoji","url":"interfaces/ButtonOptionsRequired.html#emoji","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":23,"kind":1024,"name":"label","url":"interfaces/ButtonOptionsRequired.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":24,"kind":1024,"name":"style","url":"interfaces/ButtonOptionsRequired.html#style","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonOptionsRequired"},{"id":25,"kind":256,"name":"ButtonsOptions","url":"interfaces/ButtonsOptions.html","classes":"tsd-kind-interface"},{"id":26,"kind":1024,"name":"first","url":"interfaces/ButtonsOptions.html#first","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":27,"kind":1024,"name":"prev","url":"interfaces/ButtonsOptions.html#prev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":28,"kind":1024,"name":"next","url":"interfaces/ButtonsOptions.html#next","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":29,"kind":1024,"name":"last","url":"interfaces/ButtonsOptions.html#last","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptions"},{"id":30,"kind":256,"name":"ButtonsOptionsRequired","url":"interfaces/ButtonsOptionsRequired.html","classes":"tsd-kind-interface"},{"id":31,"kind":1024,"name":"first","url":"interfaces/ButtonsOptionsRequired.html#first","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":32,"kind":1024,"name":"prev","url":"interfaces/ButtonsOptionsRequired.html#prev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":33,"kind":1024,"name":"next","url":"interfaces/ButtonsOptionsRequired.html#next","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":34,"kind":1024,"name":"last","url":"interfaces/ButtonsOptionsRequired.html#last","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ButtonsOptionsRequired"},{"id":35,"kind":4194304,"name":"ButtonStyle","url":"modules.html#ButtonStyle","classes":"tsd-kind-type-alias"},{"id":36,"kind":128,"name":"Pagination","url":"classes/Pagination.html","classes":"tsd-kind-class"},{"id":37,"kind":512,"name":"constructor","url":"classes/Pagination.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"Pagination"},{"id":38,"kind":1024,"name":"interaction","url":"classes/Pagination.html#interaction","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":39,"kind":1024,"name":"buttonInfo","url":"classes/Pagination.html#buttonInfo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":40,"kind":1024,"name":"images","url":"classes/Pagination.html#images","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":41,"kind":1024,"name":"descriptions","url":"classes/Pagination.html#descriptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":42,"kind":1024,"name":"actionRows","url":"classes/Pagination.html#actionRows","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":43,"kind":1024,"name":"payloads","url":"classes/Pagination.html#payloads","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":44,"kind":1024,"name":"totalEntry","url":"classes/Pagination.html#totalEntry","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":45,"kind":1024,"name":"customFooter","url":"classes/Pagination.html#customFooter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":46,"kind":1024,"name":"mainActionRow","url":"classes/Pagination.html#mainActionRow","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":47,"kind":1024,"name":"limit","url":"classes/Pagination.html#limit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":48,"kind":1024,"name":"idle","url":"classes/Pagination.html#idle","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":49,"kind":1024,"name":"ephemeral","url":"classes/Pagination.html#ephemeral","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":50,"kind":1024,"name":"prevDescription","url":"classes/Pagination.html#prevDescription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":51,"kind":1024,"name":"postDescription","url":"classes/Pagination.html#postDescription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":52,"kind":1024,"name":"attachments","url":"classes/Pagination.html#attachments","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":53,"kind":1024,"name":"currentPage","url":"classes/Pagination.html#currentPage","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":54,"kind":1024,"name":"fieldPaginate","url":"classes/Pagination.html#fieldPaginate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Pagination"},{"id":55,"kind":1024,"name":"buttons","url":"classes/Pagination.html#buttons","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":56,"kind":65536,"name":"__type","url":"classes/Pagination.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Pagination"},{"id":57,"kind":1024,"name":"first","url":"classes/Pagination.html#__type.first","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":58,"kind":1024,"name":"prev","url":"classes/Pagination.html#__type.prev","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":59,"kind":1024,"name":"next","url":"classes/Pagination.html#__type.next","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":60,"kind":1024,"name":"last","url":"classes/Pagination.html#__type.last","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Pagination.__type"},{"id":61,"kind":1024,"name":"rawFooter","url":"classes/Pagination.html#rawFooter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":62,"kind":2048,"name":"setOptions","url":"classes/Pagination.html#setOptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":63,"kind":2048,"name":"setImages","url":"classes/Pagination.html#setImages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":64,"kind":2048,"name":"addImage","url":"classes/Pagination.html#addImage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":65,"kind":2048,"name":"addImages","url":"classes/Pagination.html#addImages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":66,"kind":2048,"name":"setDescriptions","url":"classes/Pagination.html#setDescriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":67,"kind":2048,"name":"addDescription","url":"classes/Pagination.html#addDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":68,"kind":2048,"name":"addDescriptions","url":"classes/Pagination.html#addDescriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":69,"kind":2048,"name":"paginateFields","url":"classes/Pagination.html#paginateFields","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":70,"kind":2048,"name":"setIdle","url":"classes/Pagination.html#setIdle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":71,"kind":2048,"name":"setEphemeral","url":"classes/Pagination.html#setEphemeral","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":72,"kind":2048,"name":"setLimit","url":"classes/Pagination.html#setLimit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":73,"kind":2048,"name":"setPrevDescription","url":"classes/Pagination.html#setPrevDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":74,"kind":2048,"name":"setPostDescription","url":"classes/Pagination.html#setPostDescription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":75,"kind":2048,"name":"setEmojis","url":"classes/Pagination.html#setEmojis","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":76,"kind":2048,"name":"setStyle","url":"classes/Pagination.html#setStyle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":77,"kind":2048,"name":"setButtonAppearance","url":"classes/Pagination.html#setButtonAppearance","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":78,"kind":2048,"name":"addActionRows","url":"classes/Pagination.html#addActionRows","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":79,"kind":2048,"name":"setAttachments","url":"classes/Pagination.html#setAttachments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":80,"kind":2048,"name":"addAttachment","url":"classes/Pagination.html#addAttachment","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":81,"kind":2048,"name":"addAttachments","url":"classes/Pagination.html#addAttachments","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":82,"kind":2048,"name":"readyActionRows","url":"classes/Pagination.html#readyActionRows","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":83,"kind":2048,"name":"readyPayloads","url":"classes/Pagination.html#readyPayloads","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"Pagination"},{"id":84,"kind":2048,"name":"goToPage","url":"classes/Pagination.html#goToPage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":85,"kind":2048,"name":"goFirst","url":"classes/Pagination.html#goFirst","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":86,"kind":2048,"name":"goPrev","url":"classes/Pagination.html#goPrev","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":87,"kind":2048,"name":"goNext","url":"classes/Pagination.html#goNext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":88,"kind":2048,"name":"goLast","url":"classes/Pagination.html#goLast","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":89,"kind":2048,"name":"paginate","url":"classes/Pagination.html#paginate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":90,"kind":2048,"name":"ready","url":"classes/Pagination.html#ready","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":91,"kind":2048,"name":"render","url":"classes/Pagination.html#render","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":92,"kind":2048,"name":"reply","url":"classes/Pagination.html#reply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":93,"kind":2048,"name":"followUp","url":"classes/Pagination.html#followUp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":94,"kind":2048,"name":"editReply","url":"classes/Pagination.html#editReply","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":95,"kind":2048,"name":"update","url":"classes/Pagination.html#update","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"},{"id":96,"kind":2048,"name":"send","url":"classes/Pagination.html#send","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Pagination"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,20.592]],["parent/0",[]],["name/1",[1,36.687]],["parent/1",[0,1.986]],["name/2",[2,36.687]],["parent/2",[0,1.986]],["name/3",[3,36.687]],["parent/3",[0,1.986]],["name/4",[4,36.687]],["parent/4",[0,1.986]],["name/5",[5,36.687]],["parent/5",[0,1.986]],["name/6",[6,36.687]],["parent/6",[0,1.986]],["name/7",[7,36.687]],["parent/7",[0,1.986]],["name/8",[8,36.687]],["parent/8",[0,1.986]],["name/9",[9,36.687]],["parent/9",[0,1.986]],["name/10",[10,36.687]],["parent/10",[0,1.986]],["name/11",[11,36.687]],["parent/11",[0,1.986]],["name/12",[12,28.802]],["parent/12",[]],["name/13",[8,36.687]],["parent/13",[12,2.778]],["name/14",[9,36.687]],["parent/14",[12,2.778]],["name/15",[10,36.687]],["parent/15",[12,2.778]],["name/16",[11,36.687]],["parent/16",[12,2.778]],["name/17",[13,30.809]],["parent/17",[]],["name/18",[14,36.687]],["parent/18",[13,2.972]],["name/19",[15,36.687]],["parent/19",[13,2.972]],["name/20",[16,36.687]],["parent/20",[13,2.972]],["name/21",[17,30.809]],["parent/21",[]],["name/22",[14,36.687]],["parent/22",[17,2.972]],["name/23",[15,36.687]],["parent/23",[17,2.972]],["name/24",[16,36.687]],["parent/24",[17,2.972]],["name/25",[18,28.802]],["parent/25",[]],["name/26",[19,33.322]],["parent/26",[18,2.778]],["name/27",[20,33.322]],["parent/27",[18,2.778]],["name/28",[21,33.322]],["parent/28",[18,2.778]],["name/29",[22,33.322]],["parent/29",[18,2.778]],["name/30",[23,28.802]],["parent/30",[]],["name/31",[19,33.322]],["parent/31",[23,2.778]],["name/32",[20,33.322]],["parent/32",[23,2.778]],["name/33",[21,33.322]],["parent/33",[23,2.778]],["name/34",[22,33.322]],["parent/34",[23,2.778]],["name/35",[7,36.687]],["parent/35",[]],["name/36",[24,5.332]],["parent/36",[]],["name/37",[25,41.795]],["parent/37",[24,0.514]],["name/38",[26,41.795]],["parent/38",[24,0.514]],["name/39",[27,41.795]],["parent/39",[24,0.514]],["name/40",[28,41.795]],["parent/40",[24,0.514]],["name/41",[29,41.795]],["parent/41",[24,0.514]],["name/42",[30,41.795]],["parent/42",[24,0.514]],["name/43",[31,41.795]],["parent/43",[24,0.514]],["name/44",[32,41.795]],["parent/44",[24,0.514]],["name/45",[33,41.795]],["parent/45",[24,0.514]],["name/46",[34,41.795]],["parent/46",[24,0.514]],["name/47",[1,36.687]],["parent/47",[24,0.514]],["name/48",[2,36.687]],["parent/48",[24,0.514]],["name/49",[3,36.687]],["parent/49",[24,0.514]],["name/50",[4,36.687]],["parent/50",[24,0.514]],["name/51",[5,36.687]],["parent/51",[24,0.514]],["name/52",[6,36.687]],["parent/52",[24,0.514]],["name/53",[35,41.795]],["parent/53",[24,0.514]],["name/54",[36,41.795]],["parent/54",[24,0.514]],["name/55",[37,41.795]],["parent/55",[24,0.514]],["name/56",[38,41.795]],["parent/56",[24,0.514]],["name/57",[19,33.322]],["parent/57",[39,2.972]],["name/58",[20,33.322]],["parent/58",[39,2.972]],["name/59",[21,33.322]],["parent/59",[39,2.972]],["name/60",[22,33.322]],["parent/60",[39,2.972]],["name/61",[40,41.795]],["parent/61",[24,0.514]],["name/62",[41,41.795]],["parent/62",[24,0.514]],["name/63",[42,41.795]],["parent/63",[24,0.514]],["name/64",[43,41.795]],["parent/64",[24,0.514]],["name/65",[44,41.795]],["parent/65",[24,0.514]],["name/66",[45,41.795]],["parent/66",[24,0.514]],["name/67",[46,41.795]],["parent/67",[24,0.514]],["name/68",[47,41.795]],["parent/68",[24,0.514]],["name/69",[48,41.795]],["parent/69",[24,0.514]],["name/70",[49,41.795]],["parent/70",[24,0.514]],["name/71",[50,41.795]],["parent/71",[24,0.514]],["name/72",[51,41.795]],["parent/72",[24,0.514]],["name/73",[52,41.795]],["parent/73",[24,0.514]],["name/74",[53,41.795]],["parent/74",[24,0.514]],["name/75",[54,41.795]],["parent/75",[24,0.514]],["name/76",[55,41.795]],["parent/76",[24,0.514]],["name/77",[56,41.795]],["parent/77",[24,0.514]],["name/78",[57,41.795]],["parent/78",[24,0.514]],["name/79",[58,41.795]],["parent/79",[24,0.514]],["name/80",[59,41.795]],["parent/80",[24,0.514]],["name/81",[60,41.795]],["parent/81",[24,0.514]],["name/82",[61,41.795]],["parent/82",[24,0.514]],["name/83",[62,41.795]],["parent/83",[24,0.514]],["name/84",[63,41.795]],["parent/84",[24,0.514]],["name/85",[64,41.795]],["parent/85",[24,0.514]],["name/86",[65,41.795]],["parent/86",[24,0.514]],["name/87",[66,41.795]],["parent/87",[24,0.514]],["name/88",[67,41.795]],["parent/88",[24,0.514]],["name/89",[68,41.795]],["parent/89",[24,0.514]],["name/90",[69,41.795]],["parent/90",[24,0.514]],["name/91",[70,41.795]],["parent/91",[24,0.514]],["name/92",[71,41.795]],["parent/92",[24,0.514]],["name/93",[72,41.795]],["parent/93",[24,0.514]],["name/94",[73,41.795]],["parent/94",[24,0.514]],["name/95",[74,41.795]],["parent/95",[24,0.514]],["name/96",[75,41.795]],["parent/96",[24,0.514]]],"invertedIndex":[["__type",{"_index":38,"name":{"56":{}},"parent":{}}],["actionrows",{"_index":30,"name":{"42":{}},"parent":{}}],["addactionrows",{"_index":57,"name":{"78":{}},"parent":{}}],["addattachment",{"_index":59,"name":{"80":{}},"parent":{}}],["addattachments",{"_index":60,"name":{"81":{}},"parent":{}}],["adddescription",{"_index":46,"name":{"67":{}},"parent":{}}],["adddescriptions",{"_index":47,"name":{"68":{}},"parent":{}}],["addimage",{"_index":43,"name":{"64":{}},"parent":{}}],["addimages",{"_index":44,"name":{"65":{}},"parent":{}}],["attachments",{"_index":6,"name":{"6":{},"52":{}},"parent":{}}],["buttoninfo",{"_index":27,"name":{"39":{}},"parent":{}}],["buttonoptions",{"_index":13,"name":{"17":{}},"parent":{"18":{},"19":{},"20":{}}}],["buttonoptionsrequired",{"_index":17,"name":{"21":{}},"parent":{"22":{},"23":{},"24":{}}}],["buttons",{"_index":37,"name":{"55":{}},"parent":{}}],["buttonsoptions",{"_index":18,"name":{"25":{}},"parent":{"26":{},"27":{},"28":{},"29":{}}}],["buttonsoptionsrequired",{"_index":23,"name":{"30":{}},"parent":{"31":{},"32":{},"33":{},"34":{}}}],["buttonstyle",{"_index":7,"name":{"7":{},"35":{}},"parent":{}}],["constructor",{"_index":25,"name":{"37":{}},"parent":{}}],["currentpage",{"_index":35,"name":{"53":{}},"parent":{}}],["customfooter",{"_index":33,"name":{"45":{}},"parent":{}}],["descriptions",{"_index":29,"name":{"41":{}},"parent":{}}],["editreply",{"_index":73,"name":{"94":{}},"parent":{}}],["emoji",{"_index":14,"name":{"18":{},"22":{}},"parent":{}}],["emojioptions",{"_index":12,"name":{"12":{}},"parent":{"13":{},"14":{},"15":{},"16":{}}}],["ephemeral",{"_index":3,"name":{"3":{},"49":{}},"parent":{}}],["fieldpaginate",{"_index":36,"name":{"54":{}},"parent":{}}],["first",{"_index":19,"name":{"26":{},"31":{},"57":{}},"parent":{}}],["firstemoji",{"_index":8,"name":{"8":{},"13":{}},"parent":{}}],["followup",{"_index":72,"name":{"93":{}},"parent":{}}],["gofirst",{"_index":64,"name":{"85":{}},"parent":{}}],["golast",{"_index":67,"name":{"88":{}},"parent":{}}],["gonext",{"_index":66,"name":{"87":{}},"parent":{}}],["goprev",{"_index":65,"name":{"86":{}},"parent":{}}],["gotopage",{"_index":63,"name":{"84":{}},"parent":{}}],["idle",{"_index":2,"name":{"2":{},"48":{}},"parent":{}}],["images",{"_index":28,"name":{"40":{}},"parent":{}}],["interaction",{"_index":26,"name":{"38":{}},"parent":{}}],["label",{"_index":15,"name":{"19":{},"23":{}},"parent":{}}],["last",{"_index":22,"name":{"29":{},"34":{},"60":{}},"parent":{}}],["lastemoji",{"_index":11,"name":{"11":{},"16":{}},"parent":{}}],["limit",{"_index":1,"name":{"1":{},"47":{}},"parent":{}}],["mainactionrow",{"_index":34,"name":{"46":{}},"parent":{}}],["next",{"_index":21,"name":{"28":{},"33":{},"59":{}},"parent":{}}],["nextemoji",{"_index":10,"name":{"10":{},"15":{}},"parent":{}}],["options",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{}}}],["paginate",{"_index":68,"name":{"89":{}},"parent":{}}],["paginatefields",{"_index":48,"name":{"69":{}},"parent":{}}],["pagination",{"_index":24,"name":{"36":{}},"parent":{"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"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":{}}}],["pagination.__type",{"_index":39,"name":{},"parent":{"57":{},"58":{},"59":{},"60":{}}}],["payloads",{"_index":31,"name":{"43":{}},"parent":{}}],["postdescription",{"_index":5,"name":{"5":{},"51":{}},"parent":{}}],["prev",{"_index":20,"name":{"27":{},"32":{},"58":{}},"parent":{}}],["prevdescription",{"_index":4,"name":{"4":{},"50":{}},"parent":{}}],["prevemoji",{"_index":9,"name":{"9":{},"14":{}},"parent":{}}],["rawfooter",{"_index":40,"name":{"61":{}},"parent":{}}],["ready",{"_index":69,"name":{"90":{}},"parent":{}}],["readyactionrows",{"_index":61,"name":{"82":{}},"parent":{}}],["readypayloads",{"_index":62,"name":{"83":{}},"parent":{}}],["render",{"_index":70,"name":{"91":{}},"parent":{}}],["reply",{"_index":71,"name":{"92":{}},"parent":{}}],["send",{"_index":75,"name":{"96":{}},"parent":{}}],["setattachments",{"_index":58,"name":{"79":{}},"parent":{}}],["setbuttonappearance",{"_index":56,"name":{"77":{}},"parent":{}}],["setdescriptions",{"_index":45,"name":{"66":{}},"parent":{}}],["setemojis",{"_index":54,"name":{"75":{}},"parent":{}}],["setephemeral",{"_index":50,"name":{"71":{}},"parent":{}}],["setidle",{"_index":49,"name":{"70":{}},"parent":{}}],["setimages",{"_index":42,"name":{"63":{}},"parent":{}}],["setlimit",{"_index":51,"name":{"72":{}},"parent":{}}],["setoptions",{"_index":41,"name":{"62":{}},"parent":{}}],["setpostdescription",{"_index":53,"name":{"74":{}},"parent":{}}],["setprevdescription",{"_index":52,"name":{"73":{}},"parent":{}}],["setstyle",{"_index":55,"name":{"76":{}},"parent":{}}],["style",{"_index":16,"name":{"20":{},"24":{}},"parent":{}}],["totalentry",{"_index":32,"name":{"44":{}},"parent":{}}],["update",{"_index":74,"name":{"95":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/classes/Pagination.html b/docs/classes/Pagination.html index f72b183..c5f35d5 100644 --- a/docs/classes/Pagination.html +++ b/docs/classes/Pagination.html @@ -1,195 +1,204 @@ -Pagination | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pagination

Hierarchy

  • MessageEmbed
    • Pagination

Index

Constructors

constructor

  • new Pagination(interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>, options?: Options): Pagination
  • example

    const pagination = new Pagination(interaction, { - firstEmoji: "⏮", -prevEmoji: "⬅️", -nextEmoji: "➡️", -lastEmoji: "⏭", -limit: 5, -idle: 5 * 60 * 1000, -ephemeral: false, -prevDescription: "", -postDescription: "", -attachments: [], -buttonStyle: "SECONDARY", -});

    -

    Parameters

    • interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>
    • options: Options = {}

    Returns Pagination

Properties

actionRows

actionRows: MessageActionRow[]

attachments

attachments: MessageAttachment[]

author

author: null | MessageEmbedAuthor

Readonly buttonInfo

buttons

buttons: { first: MessageButton; last: MessageButton; next: MessageButton; prev: MessageButton }

Type declaration

  • first: MessageButton
  • last: MessageButton
  • next: MessageButton
  • prev: MessageButton

color

color: null | number

Readonly createdAt

createdAt: null | Date

currentPage

currentPage: number

Private customFooter

customFooter: boolean

description

description: null | string

descriptions

descriptions: string[]

ephemeral

ephemeral: boolean

fieldPaginate

fieldPaginate: boolean

fields

fields: EmbedField[]

footer

footer: null | MessageEmbedFooter

Readonly hexColor

hexColor: null | `#${string}`

idle

idle: number

image

image: null | MessageEmbedImage

images

images: string[]

Readonly interaction

interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>

Readonly length

length: number

limit

limit: number

Private Readonly mainActionRow

mainActionRow: MessageActionRow

Private Readonly payloads

payloads: InteractionReplyOptions & { fetchReply: true }

postDescription

postDescription: string

prevDescription

prevDescription: string

provider

provider: null | MessageEmbedProvider

rawFooter

rawFooter: string

thumbnail

thumbnail: null | MessageEmbedThumbnail

timestamp

timestamp: null | number

title

title: null | string

totalEntry

totalEntry: number

type

type: string
deprecated

url

url: null | string

Readonly video

video: null | MessageEmbedVideo

Methods

addActionRows

  • addActionRows(actionRows: MessageActionRow[], position?: "below" | "above"): Pagination
  • +Pagination | pagination.djs
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Pagination

    Hierarchy

    • MessageEmbed
      • Pagination

    Index

    Constructors

    constructor

    • new Pagination(interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>, options?: Options): Pagination
    • example
      const pagination = new Pagination(interaction, {
      firstEmoji: "⏮",
      prevEmoji: "◀️",
      nextEmoji: "▶️",
      lastEmoji: "⏭",
      limit: 5,
      idle: 5 * 60 * 1000,
      ephemeral: false,
      prevDescription: "",
      postDescription: "",
      attachments: [],
      buttonStyle: "SECONDARY",
      }); +
      +

      Parameters

      • interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>
      • options: Options = {}

      Returns Pagination

    Properties

    actionRows

    actionRows: MessageActionRow[]
    +

    the action rows of the final message

    +

    attachments

    attachments: MessageAttachment[]
    +

    the attachments to show with the paginated messages

    +
    default

    []

    +

    author

    author: null | MessageEmbedAuthor

    Readonly buttonInfo

    +

    pagination button infos

    +
    readonly
    default

    { + first: { + emoji: "⏮", + label: "", + style: "SECONDARY", + }, + prev: { + emoji: "◀️", + label: "", + style: "SECONDARY", + }, + next: { + emoji: "▶️", + label: "", + style: "SECONDARY", + }, + last: { + emoji: "⏭", + label: "", + style: "SECONDARY", + }, +}

    +

    Private buttons

    buttons: { first: MessageButton; last: MessageButton; next: MessageButton; prev: MessageButton }
    +

    pagination buttons

    +

    Type declaration

    • first: MessageButton
    • last: MessageButton
    • next: MessageButton
    • prev: MessageButton

    color

    color: null | number

    Readonly createdAt

    createdAt: null | Date

    currentPage

    currentPage: number
    +

    current page number

    +

    Private customFooter

    customFooter: boolean
    +

    footer is a custom footer

    +

    description

    description: null | string

    descriptions

    descriptions: string[]
    +

    the descriptions to paginate through

    +

    ephemeral

    ephemeral: boolean
    +

    whether the reply should be ephemeral

    +
    default

    false

    +

    fieldPaginate

    fieldPaginate: boolean
    +

    paginate through fields

    +
    default

    false

    +

    fields

    fields: EmbedField[]

    footer

    footer: null | MessageEmbedFooter

    Readonly hexColor

    hexColor: null | `#${string}`

    idle

    idle: number
    +

    idle time before closing

    +
    default

    5 minutes

    +

    image

    image: null | MessageEmbedImage

    images

    images: string[]
    +

    the images to paginate through

    +

    Readonly interaction

    interaction: CommandInteraction<CacheType> | ButtonInteraction<CacheType> | Message<boolean>
    +

    The interaction that the paginator is for.

    +
    readonly

    Readonly length

    length: number

    limit

    limit: number
    +

    per page entry limit

    +
    default

    5

    +

    Private Readonly mainActionRow

    mainActionRow: MessageActionRow
    +

    main action row

    +
    readonly

    Private Readonly payloads

    payloads: InteractionReplyOptions & { fetchReply: true }
    +

    the payloads of the final message

    +
    readonly

    postDescription

    postDescription: string
    +

    the description to show after the paginated descriptions

    +
    default

    ""

    +

    prevDescription

    prevDescription: string
    +

    the description to show before the paginated descriptions

    +
    default

    ""

    +

    provider

    provider: null | MessageEmbedProvider

    Private rawFooter

    rawFooter: string
    +

    raw footer text

    +

    thumbnail

    thumbnail: null | MessageEmbedThumbnail

    timestamp

    timestamp: null | number

    title

    title: null | string

    totalEntry

    totalEntry: number
    +

    the total number of entries

    +

    type

    type: string
    deprecated

    url

    url: null | string

    Readonly video

    video: null | MessageEmbedVideo

    Methods

    addActionRows

    • addActionRows(actionRows: MessageActionRow[], position?: "below" | "above"): Pagination
    • add a custom action row below or above the pagination button action row

      -
      example

      const pagination = new Pagination(interaction) -.addActionRows([new MessageActionRow()], "above")

      -

      Parameters

      • actionRows: MessageActionRow[]
      • position: "below" | "above" = "below"

      Returns Pagination

    addAttachment

    • addAttachment(attachment: MessageAttachment): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .addActionRows([new MessageActionRow()], "above") +
      +

      Parameters

      • actionRows: MessageActionRow[]
      • position: "below" | "above" = "below"

      Returns Pagination

    addAttachment

    • addAttachment(attachment: MessageAttachment): Pagination
    • add a attachment to the existing attachments

      -
      example

      const pagination = new Pagination(interaction) -.setAttachments([new MessageAttachment()]) -.addAttachment(new MessageAttachment())

      -

      Parameters

      • attachment: MessageAttachment

      Returns Pagination

    addAttachments

    • addAttachments(attachments: MessageAttachment[]): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .setAttachments([new MessageAttachment()])
      .addAttachment(new MessageAttachment()) +
      +

      Parameters

      • attachment: MessageAttachment

      Returns Pagination

    addAttachments

    • addAttachments(attachments: MessageAttachment[]): Pagination
    • add multiple attachments to the existing attachments

      -
      example

      const pagination = new Pagination(interaction) -.setAttachments([new MessageAttachment()]) -.addAttachments([new MessageAttachment(), new MessageAttachment()])

      -

      Parameters

      • attachments: MessageAttachment[]

      Returns Pagination

    addDescription

    • +
      example
      const pagination = new Pagination(interaction)
      .setAttachments([new MessageAttachment()])
      .addAttachments([new MessageAttachment(), new MessageAttachment()]) +
      +

      Parameters

      • attachments: MessageAttachment[]

      Returns Pagination

    addDescription

    • add a pagination description

      -
      example

      const pagination = new Pagination(interaction) -.setDescriptions(["1st description", "2nd description", "3rd description"]) -.addDescription("4st description");

      -

      Parameters

      • description: string

      Returns Pagination

    addDescriptions

    • addDescriptions(descriptions: string[]): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .setDescriptions(["1st description", "2nd description", "3rd description"])
      .addDescription("4st description"); +
      +

      Parameters

      • description: string

      Returns Pagination

    addDescriptions

    • addDescriptions(descriptions: string[]): Pagination
    • add multiple pagination descriptions

      -
      example

      const pagination = new Pagination(interaction) -.setDescriptions(["1st description", "2nd description", "3rd description"]) -.addDescriptions(["4st description", "5nd description", "6rd description"]);

      -

      Parameters

      • descriptions: string[]

      Returns Pagination

    addField

    • addField(name: string, value: string, inline?: boolean): Pagination
    • Parameters

      • name: string
      • value: string
      • Optional inline: boolean

      Returns Pagination

    addFields

    • addFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    addImage

    • +
      example
      const pagination = new Pagination(interaction)
      .setDescriptions(["1st description", "2nd description", "3rd description"])
      .addDescriptions(["4st description", "5nd description", "6rd description"]); +
      +

      Parameters

      • descriptions: string[]

      Returns Pagination

    addField

    • addField(name: string, value: string, inline?: boolean): Pagination
    • Parameters

      • name: string
      • value: string
      • Optional inline: boolean

      Returns Pagination

    addFields

    • addFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    addImage

    • add a pagination images

      -
      example

      const pagination = new Pagination(interaction) -.setImages(["1st image", "2nd image", "3rd image"]) -.addImage("4st image");

      -

      Parameters

      • image: string

      Returns Pagination

    addImages

    • +
      example
      const pagination = new Pagination(interaction)
      .setImages(["1st image", "2nd image", "3rd image"])
      .addImage("4st image"); +
      +

      Parameters

      • image: string

      Returns Pagination

    addImages

    • add multiple pagination images

      -
      example

      const pagination = new Pagination(interaction) -.setImages(["1st image", "2nd image", "3rd image"]) -.addImages(["4st image", "5nd image", "6rd image"]);

      -

      Parameters

      • images: string[]

      Returns Pagination

    editReply

    • editReply(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      .setImages(["1st image", "2nd image", "3rd image"])
      .addImages(["4st image", "5nd image", "6rd image"]); +
      +

      Parameters

      • images: string[]

      Returns Pagination

    editReply

    • editReply(): Promise<Message<boolean>>
    • edit the original reply with the final message

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.editReply()

      -

      Returns Promise<Message<boolean>>

    equals

    • equals(embed: MessageEmbed | APIEmbed): boolean
    • Parameters

      • embed: MessageEmbed | APIEmbed

      Returns boolean

    followUp

    • followUp(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.editReply() +
      +

      Returns Promise<Message<boolean>>

    equals

    • equals(embed: MessageEmbed | APIEmbed): boolean
    • Parameters

      • embed: MessageEmbed | APIEmbed

      Returns boolean

    followUp

    • followUp(): Promise<Message<boolean>>
    • send reply as a followUp

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.followUp()

      -

      Returns Promise<Message<boolean>>

    goFirst

    • goFirst(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.followUp() +
      +

      Returns Promise<Message<boolean>>

    goFirst

    • goFirst(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • go to the first page

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.goFirst(i)

      -

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goLast

    • goLast(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.goFirst(i) +
      +

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goLast

    • goLast(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • go to the last page

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.goLast(i)

      -

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goNext

    • goNext(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.goLast(i) +
      +

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goNext

    • goNext(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • go to the next page

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.goNext(i)

      -

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goPrev

    • goPrev(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.goNext(i) +
      +

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goPrev

    • goPrev(i: ButtonInteraction<CacheType>): ButtonInteraction<CacheType>
    • go to the previous page

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.goPrev(i)

      -

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goToPage

    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.goPrev(i) +
      +

      Parameters

      • i: ButtonInteraction<CacheType>

      Returns ButtonInteraction<CacheType>

    goToPage

    • go to a specific page

      -
      example

      const pagination = new Pagination(interaction) -.setLimit(1) -.setDescriptions(["1st page", "2nd page", "3rd page", "4th page", "5th page"]) -... -pagination.goToPage(2)

      -

      Parameters

      • pageNumber: number

      Returns Pagination

    paginate

    • +
      example
      const pagination = new Pagination(interaction)
      .setLimit(1)
      .setDescriptions(["1st page", "2nd page", "3rd page", "4th page", "5th page"])
      ...
      pagination.goToPage(2) +
      +

      Parameters

      • pageNumber: number

      Returns Pagination

    paginate

    • make the pagination interactive

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.paginate(message)

      -

      Parameters

      • message: Message<boolean>

      Returns Pagination

    paginateFields

    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.paginate(message) +
      +

      Parameters

      • message: Message<boolean>

      Returns Pagination

    paginateFields

    • paginate through fields

      -
      example

      const pagination = new Pagination(interaction) -.setFields([{ -name: "Field 1", -value: "Field 1 value", -}, -{ -name: "Field 2", -value: "Field 2 value", -}]) -.paginateFields(true);

      -

      Parameters

      • paginate: boolean

      Returns Pagination

    ready

    • ready(): InteractionReplyOptions & { fetchReply: true }
    • +
      example
      const pagination = new Pagination(interaction)
      .setFields([{
      name: "Field 1",
      value: "Field 1 value",
      },
      {
      name: "Field 2",
      value: "Field 2 value",
      }])
      .paginateFields(true); +
      +

      Parameters

      • paginate: boolean

      Returns Pagination

    ready

    • ready(): InteractionReplyOptions & { fetchReply: true }
    • ready the pagination

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.ready()

      -

      Returns InteractionReplyOptions & { fetchReply: true }

    readyActionRows

    readyPayloads

    • readyPayloads(): InteractionReplyOptions & { fetchReply: true }
    • Returns InteractionReplyOptions & { fetchReply: true }

    render

    • render(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.ready() +
      +

      Returns InteractionReplyOptions & { fetchReply: true }

    Private readyActionRows

    Private readyPayloads

    • readyPayloads(): InteractionReplyOptions & { fetchReply: true }
    • +

      ready message payloads

      +

      Returns InteractionReplyOptions & { fetchReply: true }

    render

    • render(): Promise<Message<boolean>>
    • send the final message

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.render()

      -

      Returns Promise<Message<boolean>>

    reply

    • reply(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.render() +
      +

      Returns Promise<Message<boolean>>

    reply

    • reply(): Promise<Message<boolean>>
    • reply the final message

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.reply()

      -

      Returns Promise<Message<boolean>>

    send

    • send(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.reply() +
      +

      Returns Promise<Message<boolean>>

    send

    • send(): Promise<Message<boolean>>
    • send the final message in the interaction channel

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.send()

      -

      Returns Promise<Message<boolean>>

    setAttachments

    • setAttachments(attachments: MessageAttachment[]): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      ...
      pagination.send() +
      +

      Returns Promise<Message<boolean>>

    setAttachments

    • setAttachments(attachments: MessageAttachment[]): Pagination
    • send a attachment along with the embed

      -
      example

      const pagination = new Pagination(interaction) -.setAttachments([new MessageAttachment()])

      -

      Parameters

      • attachments: MessageAttachment[]

      Returns Pagination

    setAuthor

    • setAuthor(name: string, iconURL?: string, url?: string): Pagination
    • Parameters

      • name: string
      • Optional iconURL: string
      • Optional url: string

      Returns Pagination

    setButtonAppearance

    • +
      example
      const pagination = new Pagination(interaction)
      .setAttachments([new MessageAttachment()]) +
      +

      Parameters

      • attachments: MessageAttachment[]

      Returns Pagination

    setAuthor

    • setAuthor(name: string, iconURL?: string, url?: string): Pagination
    • Parameters

      • name: string
      • Optional iconURL: string
      • Optional url: string

      Returns Pagination

    setButtonAppearance

    • customize button styles

      -
      example

      const pagination = new Pagination(interaction) -.setButtonAppearance({ -first: { -label: "First", -emoji: ":first_emoji:", -style: "SECONDARY" -}})

      -

      Parameters

      Returns Pagination

    setColor

    • Parameters

      • color: ColorResolvable

      Returns Pagination

    setDescription

    • Parameters

      • description: string

      Returns Pagination

    setDescriptions

    • setDescriptions(descriptions: string[]): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .setButtonAppearance({
      first: {
      label: "First",
      emoji: ":first_emoji:",
      style: "SECONDARY"
      }}) +
      +

      Parameters

      Returns Pagination

    setColor

    • Parameters

      • color: ColorResolvable

      Returns Pagination

    setDescription

    • Parameters

      • description: string

      Returns Pagination

    setDescriptions

    • setDescriptions(descriptions: string[]): Pagination
    • set pagination descriptions

      -
      example

      const pagination = new Pagination(interaction) -.setDescriptions(["1st description", "2nd description", "3rd description"]);

      -

      Parameters

      • descriptions: string[]

      Returns Pagination

    setEmojis

    • +
      example
      const pagination = new Pagination(interaction)
      .setDescriptions(["1st description", "2nd description", "3rd description"]); +
      +

      Parameters

      • descriptions: string[]

      Returns Pagination

    setEmojis

    • change default emoji for buttons

      -
      example

      const pagination = new Pagination(interaction) -.setEmojis({ -firstEmoji: ":first_emoji:", -prevEmoji: ":prev_emoji:", -nextEmoji: ":next_emoji:", -lastEmoji: ":last_emoji:" -})

      -

      Parameters

      Returns Pagination

    setEphemeral

    • +
      example
      const pagination = new Pagination(interaction)
      .setEmojis({
      firstEmoji: ":first_emoji:",
      prevEmoji: ":prev_emoji:",
      nextEmoji: ":next_emoji:",
      lastEmoji: ":last_emoji:"
      }) +
      +

      Parameters

      Returns Pagination

    setEphemeral

    • set ephemeral for pagination

      -
      example

      const pagination = new Pagination(interaction) -.setEphemeral(true)

      -

      Parameters

      • ephemeral: boolean

      Returns Pagination

    setFields

    • setFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    setFooter

    • setFooter(text: string, iconURL?: string): Pagination
    • Parameters

      • text: string
      • Optional iconURL: string

      Returns Pagination

    setIdle

    • +
      example
      const pagination = new Pagination(interaction)
      .setEphemeral(true) +
      +

      Parameters

      • ephemeral: boolean

      Returns Pagination

    setFields

    • setFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    setFooter

    • setFooter(text: string, iconURL?: string): Pagination
    • Parameters

      • text: string
      • Optional iconURL: string

      Returns Pagination

    setIdle

    • set idle time for pagination

      -
      example

      const pagination = new Pagination(interaction) -.setIdle(5 * 60 * 1000)

      -

      Parameters

      • idle: number

      Returns Pagination

    setImage

    • Parameters

      • url: string

      Returns Pagination

    setImages

    • +
      example
      const pagination = new Pagination(interaction)
      .setIdle(5 * 60 * 1000) +
      +

      Parameters

      • idle: number

      Returns Pagination

    setImage

    • Parameters

      • url: string

      Returns Pagination

    setImages

    • set pagination images

      -
      example

      const pagination = new Pagination(interaction) -.setImages(["1st image", "2nd image", "3rd image"]);

      -

      Parameters

      • images: string[]

      Returns Pagination

    setLimit

    • +
      example
      const pagination = new Pagination(interaction)
      .setImages(["1st image", "2nd image", "3rd image"]); +
      +

      Parameters

      • images: string[]

      Returns Pagination

    setLimit

    • set per page limit for pagination

      -
      example

      const pagination = new Pagination(interaction) -.setLimit(5)

      -

      Parameters

      • limit: number

      Returns Pagination

    setOptions

    • +
      example
      const pagination = new Pagination(interaction)
      .setLimit(5) +
      +

      Parameters

      • limit: number

      Returns Pagination

    setOptions

    • set pagination options

      -
      example

      const pagination = new Pagination(interaction) - .setOptions({ -firstEmoji: "⏮", -prevEmoji: "⬅️", -nextEmoji: "➡️", -lastEmoji: "⏭", -limit: 5, -idle: 5 * 60 * 1000, -ephemeral: false, -prevDescription: "", -postDescription: "", -attachments: [], -buttonStyle: "SECONDARY", -});

      -

      Parameters

      Returns Pagination

    setPostDescription

    • setPostDescription(postDescription: string): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .setOptions({
      firstEmoji: "⏮",
      prevEmoji: "◀️",
      nextEmoji: "▶️",
      lastEmoji: "⏭",
      limit: 5,
      idle: 5 * 60 * 1000,
      ephemeral: false,
      prevDescription: "",
      postDescription: "",
      attachments: [],
      buttonStyle: "SECONDARY",
      }); +
      +

      Parameters

      Returns Pagination

    setPostDescription

    • setPostDescription(postDescription: string): Pagination
    • set a fixed post descriptions which will be shown in all pages after the paginated descriptions

      -
      example

      const pagination = new Pagination(interaction) -.setPostDescription("role id: 123456789")

      -

      Parameters

      • postDescription: string

      Returns Pagination

    setPrevDescription

    • setPrevDescription(prevDescription: string): Pagination
    • +
      example
      const pagination = new Pagination(interaction)
      .setPostDescription("role id: 123456789") +
      +

      Parameters

      • postDescription: string

      Returns Pagination

    setPrevDescription

    • setPrevDescription(prevDescription: string): Pagination
    • set a fixed prev descriptions which will be shown in all pages before the paginated descriptions

      -
      example

      const pagination = new Pagination(interaction) -.setPrevDescription("role info")

      -

      Parameters

      • prevDescription: string

      Returns Pagination

    setStyle

    setThumbnail

    • Parameters

      • url: string

      Returns Pagination

    setTimestamp

    • setTimestamp(timestamp?: null | number | Date): Pagination
    • Parameters

      • Optional timestamp: null | number | Date

      Returns Pagination

    setTitle

    • Parameters

      • title: string

      Returns Pagination

    setURL

    • Parameters

      • url: string

      Returns Pagination

    spliceFields

    • spliceFields(index: number, deleteCount: number, ...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • index: number
      • deleteCount: number
      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    toJSON

    • toJSON(): APIEmbed
    • Returns APIEmbed

    update

    • update(): Promise<Message<boolean>>
    • +
      example
      const pagination = new Pagination(interaction)
      .setPrevDescription("role info") +
      +

      Parameters

      • prevDescription: string

      Returns Pagination

    setStyle

    setThumbnail

    • Parameters

      • url: string

      Returns Pagination

    setTimestamp

    • setTimestamp(timestamp?: null | number | Date): Pagination
    • Parameters

      • Optional timestamp: null | number | Date

      Returns Pagination

    setTitle

    • Parameters

      • title: string

      Returns Pagination

    setURL

    • Parameters

      • url: string

      Returns Pagination

    spliceFields

    • spliceFields(index: number, deleteCount: number, ...fields: EmbedFieldData[] | EmbedFieldData[][]): Pagination
    • Parameters

      • index: number
      • deleteCount: number
      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Pagination

    toJSON

    • toJSON(): APIEmbed
    • Returns APIEmbed

    update

    • update(): Promise<Message<boolean>>
    • update to button interaction

      -
      example

      const pagination = new Pagination(interaction) -... -pagination.update()

      -

      Returns Promise<Message<boolean>>

    Static normalizeField

    • normalizeField(name: string, value: string, inline?: boolean): Required<EmbedFieldData>
    • Parameters

      • name: string
      • value: string
      • Optional inline: boolean

      Returns Required<EmbedFieldData>

    Static normalizeFields

    • normalizeFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Required<EmbedFieldData>[]
    • Parameters

      • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

      Returns Required<EmbedFieldData>[]

    Legend

    • Constructor
    • Property
    • Method
    • Property
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
    example
    const pagination = new Pagination(interaction)
    ...
    pagination.update() +
    +

    Returns Promise<Message<boolean>>

Static normalizeField

  • normalizeField(name: string, value: string, inline?: boolean): Required<EmbedFieldData>
  • Parameters

    • name: string
    • value: string
    • Optional inline: boolean

    Returns Required<EmbedFieldData>

Static normalizeFields

  • normalizeFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Required<EmbedFieldData>[]
  • Parameters

    • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

    Returns Required<EmbedFieldData>[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 806b13a..9609002 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,7 @@ -pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

pagination.djs

+pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

pagination.djs

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ButtonOptions.html b/docs/interfaces/ButtonOptions.html index 24f6830..bd4fe23 100644 --- a/docs/interfaces/ButtonOptions.html +++ b/docs/interfaces/ButtonOptions.html @@ -1 +1,9 @@ -ButtonOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonOptions

Hierarchy

  • ButtonOptions

Index

Properties

Properties

Optional emoji

emoji?: EmojiIdentifierResolvable

Optional label

label?: string

Optional style

style?: ButtonStyle

Generated using TypeDoc

\ No newline at end of file +ButtonOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonOptions

Hierarchy

  • ButtonOptions

Index

Properties

Properties

Optional emoji

emoji?: EmojiIdentifierResolvable
+

The emoji to use for the button.

+

Optional label

label?: string
+

The text to show on the button.

+
default

""

+

Optional style

style?: ButtonStyle
+

The style of the button.

+
default

"SECONDARY"

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ButtonOptionsRequired.html b/docs/interfaces/ButtonOptionsRequired.html index 2ecc07c..e6800a5 100644 --- a/docs/interfaces/ButtonOptionsRequired.html +++ b/docs/interfaces/ButtonOptionsRequired.html @@ -1 +1,9 @@ -ButtonOptionsRequired | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonOptionsRequired

Hierarchy

  • ButtonOptionsRequired

Index

Properties

Properties

emoji

emoji: EmojiIdentifierResolvable

label

label: string

style

Generated using TypeDoc

\ No newline at end of file +ButtonOptionsRequired | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonOptionsRequired

Hierarchy

  • ButtonOptionsRequired

Index

Properties

Properties

emoji

emoji: EmojiIdentifierResolvable
+

The emoji to use for the button.

+

label

label: string
+

The text to show on the button.

+
default

""

+

style

+

The style of the button.

+
default

"SECONDARY"

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ButtonsOptions.html b/docs/interfaces/ButtonsOptions.html index d2c25d6..667b240 100644 --- a/docs/interfaces/ButtonsOptions.html +++ b/docs/interfaces/ButtonsOptions.html @@ -1 +1,9 @@ -ButtonsOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonsOptions

Hierarchy

  • ButtonsOptions

Index

Properties

Optional first

Optional last

Optional next

Optional prev

Generated using TypeDoc

\ No newline at end of file +ButtonsOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonsOptions

Hierarchy

  • ButtonsOptions

Index

Properties

Optional first

+

The first button of the pagination row

+

Optional last

+

The last button of the pagination row

+

Optional next

+

The next button of the pagination row

+

Optional prev

+

The previous button of the pagination row

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ButtonsOptionsRequired.html b/docs/interfaces/ButtonsOptionsRequired.html index 95a3b0d..1452fca 100644 --- a/docs/interfaces/ButtonsOptionsRequired.html +++ b/docs/interfaces/ButtonsOptionsRequired.html @@ -1 +1,9 @@ -ButtonsOptionsRequired | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonsOptionsRequired

Hierarchy

  • ButtonsOptionsRequired

Index

Properties

first

last

next

prev

Generated using TypeDoc

\ No newline at end of file +ButtonsOptionsRequired | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ButtonsOptionsRequired

Hierarchy

  • ButtonsOptionsRequired

Index

Properties

first

+

The first button of the pagination row

+

last

+

The last button of the pagination row

+

next

+

The next button of the pagination row

+

prev

+

The previous button of the pagination row

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/EmojiOptions.html b/docs/interfaces/EmojiOptions.html index 05ed28a..35ce3d8 100644 --- a/docs/interfaces/EmojiOptions.html +++ b/docs/interfaces/EmojiOptions.html @@ -1,13 +1,13 @@ -EmojiOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmojiOptions

Hierarchy

Index

Properties

Optional firstEmoji

firstEmoji?: EmojiIdentifierResolvable
+EmojiOptions | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmojiOptions

Hierarchy

Index

Properties

Optional firstEmoji

firstEmoji?: EmojiIdentifierResolvable

The emoji to use for the first button.

default

"⏮"

-

Optional lastEmoji

lastEmoji?: EmojiIdentifierResolvable
+

Optional lastEmoji

lastEmoji?: EmojiIdentifierResolvable

The emoji to use for the last button.

default

"⏭"

-

Optional nextEmoji

nextEmoji?: EmojiIdentifierResolvable
+

Optional nextEmoji

nextEmoji?: EmojiIdentifierResolvable

The emoji to use for the next button.

-
default

"➡️"

-

Optional prevEmoji

prevEmoji?: EmojiIdentifierResolvable
+
default

"▶️"

+

Optional prevEmoji

prevEmoji?: EmojiIdentifierResolvable

The emoji to use for the previous button.

-
default

"⬅️"

-

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
default

"◀️"

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index 7bdc6bb..1c206f3 100644 --- a/docs/interfaces/Options.html +++ b/docs/interfaces/Options.html @@ -1,34 +1,34 @@ -Options | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

Hierarchy

Index

Properties

Optional attachments

attachments?: MessageAttachment[]
+Options | pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

Hierarchy

Index

Properties

Optional attachments

attachments?: MessageAttachment[]

The attachments to show with the paginated messages.

default

[]

-

Optional buttonStyle

buttonStyle?: ButtonStyle
+

Optional buttonStyle

buttonStyle?: ButtonStyle

The style of the paginator buttons.

default

"SECONDARY"

-

Optional ephemeral

ephemeral?: boolean
+

Optional ephemeral

ephemeral?: boolean

Whether the reply should be ephemeral.

default

false

-

Optional firstEmoji

firstEmoji?: EmojiIdentifierResolvable
+

Optional firstEmoji

firstEmoji?: EmojiIdentifierResolvable

The emoji to use for the first button.

default

"⏮"

-

Optional idle

idle?: number
+

Optional idle

idle?: number

The number of seconds before the paginator will close after inactivity.

default

5 minutes

-

Optional lastEmoji

lastEmoji?: EmojiIdentifierResolvable
+

Optional lastEmoji

lastEmoji?: EmojiIdentifierResolvable

The emoji to use for the last button.

default

"⏭"

-

Optional limit

limit?: number
+

Optional limit

limit?: number

The number of entries to show per page.

default

5

-

Optional nextEmoji

nextEmoji?: EmojiIdentifierResolvable
+

Optional nextEmoji

nextEmoji?: EmojiIdentifierResolvable

The emoji to use for the next button.

-
default

"➡️"

-

Optional postDescription

postDescription?: string
+
default

"▶️"

+

Optional postDescription

postDescription?: string

The description to show after the paginated descriptions.

default

""

-

Optional prevDescription

prevDescription?: string
+

Optional prevDescription

prevDescription?: string

The description to show before the paginated descriptions.

default

""

-

Optional prevEmoji

prevEmoji?: EmojiIdentifierResolvable
+

Optional prevEmoji

prevEmoji?: EmojiIdentifierResolvable

The emoji to use for the previous button.

-
default

"⬅️"

-

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
default

"◀️"

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index a65e6ea..2e53fce 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1,3 @@ -pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

pagination.djs

Index

Type aliases

ButtonStyle

ButtonStyle: "PRIMARY" | "SECONDARY" | "DANGER" | "SUCCESS"

Generated using TypeDoc

\ No newline at end of file +pagination.djs
Options
All
  • Public
  • Public/Protected
  • All
Menu

pagination.djs

Index

Type aliases

ButtonStyle

ButtonStyle: "PRIMARY" | "SECONDARY" | "DANGER" | "SUCCESS"
+

The style of the paginator buttons.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/src/index.ts b/src/index.ts index d793cbe..50ee560 100644 --- a/src/index.ts +++ b/src/index.ts @@ -13,9 +13,9 @@ import { } from "discord.js"; const defaultOptions = { - firstEmoji: "⏮", - prevEmoji: "⬅️", - nextEmoji: "➡️", + firstEmoji: "⏪", + prevEmoji: "▶️", + nextEmoji: "◀️", lastEmoji: "⏭", limit: 5, idle: 5 * 60 * 1000, @@ -72,12 +72,12 @@ export interface EmojiOptions { firstEmoji?: EmojiIdentifierResolvable; /** * The emoji to use for the previous button. - * @default "⬅️" + * @default "◀️" */ prevEmoji?: EmojiIdentifierResolvable; /** * The emoji to use for the next button. - * @default "➡️" + * @default "▶️" */ nextEmoji?: EmojiIdentifierResolvable; /** @@ -88,76 +88,223 @@ export interface EmojiOptions { } export interface ButtonOptions { + /** + * The emoji to use for the button. + */ emoji?: EmojiIdentifierResolvable; + /** + * The text to show on the button. + * @default "" + */ label?: string; + /** + * The style of the button. + * @default "SECONDARY" + */ style?: ButtonStyle; } export interface ButtonOptionsRequired { + /** + * The emoji to use for the button. + */ emoji: EmojiIdentifierResolvable; + /** + * The text to show on the button. + * @default "" + */ label: string; + /** + * The style of the button. + * @default "SECONDARY" + */ style: ButtonStyle; } export interface ButtonsOptions { + /** + * The first button of the pagination row + */ first?: ButtonOptions; + /** + * The previous button of the pagination row + */ prev?: ButtonOptions; + /** + * The next button of the pagination row + */ next?: ButtonOptions; + /** + * The last button of the pagination row + */ last?: ButtonOptions; } export interface ButtonsOptionsRequired { + /** + * The first button of the pagination row + */ first: ButtonOptionsRequired; + /** + * The previous button of the pagination row + */ prev: ButtonOptionsRequired; + /** + * The next button of the pagination row + */ next: ButtonOptionsRequired; + /** + * The last button of the pagination row + */ last: ButtonOptionsRequired; } +/** + * The style of the paginator buttons. + */ export type ButtonStyle = "PRIMARY" | "SECONDARY" | "DANGER" | "SUCCESS"; class Pagination extends MessageEmbed { + /** + * The interaction that the paginator is for. + * @readonly + */ public readonly interaction: CommandInteraction | ButtonInteraction | Message; + /** + * pagination button infos + * @readonly + * @default { + * first: { + * emoji: "⏮", + * label: "", + * style: "SECONDARY", + * }, + * prev: { + * emoji: "◀️", + * label: "", + * style: "SECONDARY", + * }, + * next: { + * emoji: "▶️", + * label: "", + * style: "SECONDARY", + * }, + * last: { + * emoji: "⏭", + * label: "", + * style: "SECONDARY", + * }, + * } + */ + public readonly buttonInfo: ButtonsOptionsRequired; + /** + * the images to paginate through + */ public images: string[]; + /** + * the descriptions to paginate through + */ public descriptions: string[]; + /** + * the action rows of the final message + */ public actionRows: MessageActionRow[]; + /** + * the payloads of the final message + * @readonly + * @private + */ private readonly payloads: InteractionReplyOptions & { fetchReply: true }; + /** + * the total number of entries + */ public totalEntry: number; - public readonly buttonInfo: ButtonsOptionsRequired; + /** + * footer is a custom footer + * @private + */ + private customFooter: boolean; + /** + * main action row + * @readonly + * @private + */ + private readonly mainActionRow: MessageActionRow; + /** + * per page entry limit + * @default 5 + */ public limit!: number; + /** + * idle time before closing + * @default 5 minutes + */ public idle!: number; + /** + * whether the reply should be ephemeral + * @default false + */ public ephemeral!: boolean; + /** + * the description to show before the paginated descriptions + * @default "" + */ public prevDescription!: string; + /** + * the description to show after the paginated descriptions + * @default "" + */ public postDescription!: string; + /** + * the attachments to show with the paginated messages + * @default [] + */ public attachments!: MessageAttachment[]; + /** + * current page number + */ public currentPage!: number; - private customFooter: boolean; + /** + * paginate through fields + * @default false + */ public fieldPaginate!: boolean; - public buttons!: { + /** + * pagination buttons + * @private + */ + private buttons!: { first: MessageButton; prev: MessageButton; next: MessageButton; last: MessageButton; }; - private readonly mainActionRow: MessageActionRow; - public rawFooter!: string; + /** + * raw footer text + * @private + */ + private rawFooter!: string; /** * * @param interaction * @param options * @example + * ```javascript * const pagination = new Pagination(interaction, { * firstEmoji: "⏮", - * prevEmoji: "⬅️", - * nextEmoji: "➡️", - * lastEmoji: "⏭", - * limit: 5, - * idle: 5 * 60 * 1000, - * ephemeral: false, - * prevDescription: "", - * postDescription: "", - * attachments: [], - * buttonStyle: "SECONDARY", + * prevEmoji: "◀️", + * nextEmoji: "▶️", + * lastEmoji: "⏭", + * limit: 5, + * idle: 5 * 60 * 1000, + * ephemeral: false, + * prevDescription: "", + * postDescription: "", + * attachments: [], + * buttonStyle: "SECONDARY", * }); + * ``` + * */ constructor( @@ -166,15 +313,7 @@ class Pagination extends MessageEmbed { ) { super(); options = Object.assign({}, defaultOptions, options); - /** - * The interaction that the paginator is for. - * @readonly - */ this.interaction = interaction; - /** - * pagination button infos - * @readonly - */ this.buttonInfo = { first: { emoji: options.firstEmoji || "⏮", @@ -182,12 +321,12 @@ class Pagination extends MessageEmbed { style: "SECONDARY", }, prev: { - emoji: options.prevEmoji || "⬅️", + emoji: options.prevEmoji || "◀️", label: "", style: "SECONDARY", }, next: { - emoji: options.nextEmoji || "➡️", + emoji: options.nextEmoji || "▶️", label: "", style: "SECONDARY", }, @@ -197,38 +336,12 @@ class Pagination extends MessageEmbed { style: "SECONDARY", }, }; - /** - * the images to paginate through - */ this.images = []; - /** - * the descriptions to paginate through - */ this.descriptions = []; - /** - * the action rows of the final message - */ this.actionRows = []; - /** - * the payloads of the final message - * @readonly - * @private - */ this.payloads = { fetchReply: true }; - /** - * the total number of entries - */ this.totalEntry = 0; - /** - * footer is a custom footer - * @private - */ this.customFooter = true; - /** - * main action row - * @readonly - * @private - */ this.mainActionRow = new MessageActionRow(); this.setOptions(options); } @@ -238,20 +351,23 @@ class Pagination extends MessageEmbed { * @param options * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setOptions({ - * firstEmoji: "⏮", - * prevEmoji: "⬅️", - * nextEmoji: "➡️", - * lastEmoji: "⏭", - * limit: 5, - * idle: 5 * 60 * 1000, - * ephemeral: false, - * prevDescription: "", - * postDescription: "", - * attachments: [], - * buttonStyle: "SECONDARY", + * firstEmoji: "⏮", + * prevEmoji: "◀️", + * nextEmoji: "▶️", + * lastEmoji: "⏭", + * limit: 5, + * idle: 5 * 60 * 1000, + * ephemeral: false, + * prevDescription: "", + * postDescription: "", + * attachments: [], + * buttonStyle: "SECONDARY", * }); + * ``` + * */ setOptions(options: Options): this { this.setEmojis({ @@ -282,8 +398,11 @@ class Pagination extends MessageEmbed { * @param images * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setImages(["1st image", "2nd image", "3rd image"]); + * ``` + * */ setImages(images: string[]): this { this.images = images; @@ -295,9 +414,11 @@ class Pagination extends MessageEmbed { * @param image * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setImages(["1st image", "2nd image", "3rd image"]) * .addImage("4st image"); + * ``` * */ addImage(image: string): this { @@ -310,9 +431,11 @@ class Pagination extends MessageEmbed { * @param images * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setImages(["1st image", "2nd image", "3rd image"]) * .addImages(["4st image", "5nd image", "6rd image"]); + * ``` * */ addImages(images: string[]): this { @@ -325,8 +448,11 @@ class Pagination extends MessageEmbed { * @param descriptions * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setDescriptions(["1st description", "2nd description", "3rd description"]); + * ``` + * */ setDescriptions(descriptions: string[]): this { this.descriptions = descriptions; @@ -338,9 +464,12 @@ class Pagination extends MessageEmbed { * @param description * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setDescriptions(["1st description", "2nd description", "3rd description"]) * .addDescription("4st description"); + * ``` + * */ addDescription(description: string): this { this.descriptions.push(description); @@ -352,9 +481,12 @@ class Pagination extends MessageEmbed { * @param descriptions * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setDescriptions(["1st description", "2nd description", "3rd description"]) * .addDescriptions(["4st description", "5nd description", "6rd description"]); + * ``` + * */ addDescriptions(descriptions: string[]): this { this.descriptions.push(...descriptions); @@ -366,6 +498,7 @@ class Pagination extends MessageEmbed { * @param paginate * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setFields([{ * name: "Field 1", @@ -375,7 +508,9 @@ class Pagination extends MessageEmbed { * name: "Field 2", * value: "Field 2 value", * }]) - *.paginateFields(true); + * .paginateFields(true); + * ``` + * */ paginateFields(paginate: boolean): this { this.fieldPaginate = paginate; @@ -387,8 +522,11 @@ class Pagination extends MessageEmbed { * @param idle * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setIdle(5 * 60 * 1000) + * ``` + * */ setIdle(idle: number): this { this.idle = idle; @@ -400,8 +538,11 @@ class Pagination extends MessageEmbed { * @param ephemeral * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setEphemeral(true) + * ``` + * */ setEphemeral(ephemeral: boolean): this { this.ephemeral = ephemeral; @@ -413,8 +554,11 @@ class Pagination extends MessageEmbed { * @param limit * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setLimit(5) + * ``` + * */ setLimit(limit: number): this { this.limit = limit; @@ -426,8 +570,11 @@ class Pagination extends MessageEmbed { * @param prevDescription * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setPrevDescription("role info") + * ``` + * */ setPrevDescription(prevDescription: string): this { this.prevDescription = prevDescription; @@ -439,8 +586,11 @@ class Pagination extends MessageEmbed { * @param postDescription * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setPostDescription("role id: 123456789") + * ``` + * */ setPostDescription(postDescription: string): this { this.postDescription = postDescription; @@ -452,6 +602,7 @@ class Pagination extends MessageEmbed { * @param emojiOptions * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setEmojis({ * firstEmoji: ":first_emoji:", @@ -459,6 +610,8 @@ class Pagination extends MessageEmbed { * nextEmoji: ":next_emoji:", * lastEmoji: ":last_emoji:" * }) + * ``` + * */ setEmojis(emojiOptions: EmojiOptions): this { this.buttonInfo.first.emoji = @@ -476,8 +629,10 @@ class Pagination extends MessageEmbed { * @param style * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setStyle("SECONDARY") + * ``` * */ setStyle(style?: ButtonStyle): this { @@ -493,6 +648,7 @@ class Pagination extends MessageEmbed { * @param buttonOptions * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setButtonAppearance({ * first: { @@ -500,6 +656,7 @@ class Pagination extends MessageEmbed { * emoji: ":first_emoji:", * style: "SECONDARY" * }}) + * ``` * */ setButtonAppearance(options: ButtonsOptions): this { @@ -528,8 +685,10 @@ class Pagination extends MessageEmbed { * @param position * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .addActionRows([new MessageActionRow()], "above") + * ``` * */ addActionRows( @@ -549,8 +708,10 @@ class Pagination extends MessageEmbed { * @param attachments * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setAttachments([new MessageAttachment()]) + * ``` */ setAttachments(attachments: MessageAttachment[]): this { this.attachments = attachments; @@ -562,9 +723,12 @@ class Pagination extends MessageEmbed { * @param attachment * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setAttachments([new MessageAttachment()]) * .addAttachment(new MessageAttachment()) + * ``` + * */ addAttachment(attachment: MessageAttachment): this { this.attachments.push(attachment); @@ -576,14 +740,22 @@ class Pagination extends MessageEmbed { * @param attachments * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setAttachments([new MessageAttachment()]) * .addAttachments([new MessageAttachment(), new MessageAttachment()]) + * ``` + * */ addAttachments(attachments: MessageAttachment[]): this { this.attachments.push(...attachments); return this; } + /** + * make the pagination action rows + * @returns + * @private + */ readyActionRows(): this { this.buttons = { first: new MessageButton() @@ -624,6 +796,11 @@ class Pagination extends MessageEmbed { this.actionRows.push(this.mainActionRow); return this; } + /** + * ready message payloads + * @returns + * @private + */ readyPayloads(): InteractionReplyOptions & { fetchReply: true } { this.readyActionRows(); this.payloads.components = this.actionRows; @@ -636,11 +813,14 @@ class Pagination extends MessageEmbed { * @param pageNumber * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * .setLimit(1) * .setDescriptions(["1st page", "2nd page", "3rd page", "4th page", "5th page"]) * ... * pagination.goToPage(2) + * ``` + * */ goToPage(pageNumber: number): this { this.currentPage = pageNumber; @@ -687,9 +867,12 @@ class Pagination extends MessageEmbed { * @param i * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.goFirst(i) + * ``` + * */ goFirst(i: ButtonInteraction): ButtonInteraction { this.currentPage = 1; @@ -715,9 +898,12 @@ class Pagination extends MessageEmbed { * @param i * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.goPrev(i) + * ``` + * */ goPrev(i: ButtonInteraction): ButtonInteraction { if (this.currentPage > 1) { @@ -743,9 +929,12 @@ class Pagination extends MessageEmbed { * @param i * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.goNext(i) + * ``` + * */ goNext(i: ButtonInteraction): ButtonInteraction { if (this.currentPage < Math.ceil(this.totalEntry / this.limit)) { @@ -775,9 +964,12 @@ class Pagination extends MessageEmbed { * @param i * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.goLast(i) + * ``` + * */ goLast(i: ButtonInteraction): ButtonInteraction { this.currentPage = Math.ceil(this.totalEntry / this.limit); @@ -801,9 +993,12 @@ class Pagination extends MessageEmbed { * @param message * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.paginate(message) + * ``` + * */ paginate(message: Message): this { const collector = message.createMessageComponentCollector({ @@ -836,9 +1031,12 @@ class Pagination extends MessageEmbed { * ready the pagination * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.ready() + * ``` + * */ ready(): InteractionReplyOptions & { fetchReply: true } { this.totalEntry = Math.max(this.descriptions.length, this.images.length); @@ -854,9 +1052,12 @@ class Pagination extends MessageEmbed { * send the final message * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.render() + * ``` + * */ async render(): Promise { return await this.reply(); @@ -866,9 +1067,12 @@ class Pagination extends MessageEmbed { * reply the final message * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.reply() + * ``` + * */ async reply(): Promise { const payloads = this.ready(); @@ -883,9 +1087,12 @@ class Pagination extends MessageEmbed { * send reply as a followUp * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.followUp() + * ``` + * */ async followUp(): Promise { const payloads = this.ready(); @@ -900,9 +1107,12 @@ class Pagination extends MessageEmbed { * edit the original reply with the final message * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.editReply() + * ``` + * */ async editReply(): Promise { const payloads = this.ready(); @@ -917,9 +1127,12 @@ class Pagination extends MessageEmbed { * update to button interaction * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.update() + * ``` + * */ async update(): Promise { const payloads = this.ready(); @@ -934,9 +1147,12 @@ class Pagination extends MessageEmbed { * send the final message in the interaction channel * @returns * @example + * ```javascript * const pagination = new Pagination(interaction) * ... * pagination.send() + * ``` + * */ async send(): Promise { const payloads = this.ready(); diff --git a/tsconfig.json b/tsconfig.json index 10ebfbd..8042782 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -14,7 +14,6 @@ "moduleResolution": "node", "lib": ["es2021"], "declaration": true, - "removeComments": true, "outDir": "dist" }, "includes": ["src/**/*.ts"]