@justnoby15/discord.js-paginator v0.1.0
��< d i v i d = " t o p " a l i g n = ' c e n t e r ' >
< h 1 > d i s c o r d . j s - p a g i n a t o r < / h 1 >
< p > < i > U n o f f i c i a l < / i > P a g i n a t o r f o r @ d i s c o r d j s / d i s c o r d . j s s u p p o r t i n g S l a s h c o m m a n d s < / p >
< i m g a l t = ' n p m V e r s i o n ' s r c = ' h t t p s : / / i m g . s h i e l d s . i o / n p m / v / @ j u s t n o b y 1 5 / d i s c o r d . j s - p a g i n a t o r ? s t y l e = f o r - t h e - b a d g e ' >
< i m g a l t = ' n p m D o w n l o a d s ' s r c = ' h t t p s : / / i m g . s h i e l d s . i o / n p m / d w / @ j u s t n o b y 1 5 / d i s c o r d . j s - p a g i n a t o r ? s t y l e = f o r - t h e - b a d g e ' >
< / d i v >
# T a b l e o f C o n t e n t s
- F e a t u r e s ( # f e a t u r e s )
- I n s t a l l a t i o n ( # i n s t a l l a t i o n )
- D e p e n d e n c i e s ( # d e p e n d e n c i e s )
- E x a m p l e s ( # e x a m p l e s )
- C o d e E x a m p l e ( # c o d e )
- A P I R e f e r e n c e ( # d o c u m e n t a t i o n )
- C r e d i t s ( # c r e d i t s )
# # F e a t u r e s
- P a g i n a t e s e m b e d s , b u t c a n a l s o h a v e m e s s a g e c o n t e n t
- I n d e x S e l e c t M e n u a n d B u t t o n s t h a t c a n b e m a n u a l l y t u r n e d o f f
- S l a s h C o m m a n d o n l y s u p p o r t
# # # A s k m e q u e s t i o n s @ j u s t r a y . # 1 0 0 1 o n D i s c o r d
# # I n s t a l l a t i o n
b a s h
n p m i @ j u s t n o b y 1 5 / d i s c o r d . j s - p a g i n a t o r
# # # D e p e n d e n c i e s
- d i s c o r d . j s ( h t t p s : / / w w w . n p m j s . c o m / p a c k a g e / d i s c o r d . j s ) ( V e r s i o n > = ^ 1 4 . 1 . 2 )
# # E x a m p l e s
T h e r e a r e s i m p l e e x a m p l e s o f w h a t t h e c o d e a n d a c t u a l o u t p u t m a y l o o k l i k e . K e e p i n m i n d , a s o f v e r s i o n 0 . 0 . 3 o f t h e p a g i n a t o r , M e s s a g e s a s t h e i n t e r a c t i o n d a t a a r e n ' t h a n d l e d . T h i s i s f o r u s e r s t o o p t i m i z e D i s c o r d ' s s l a s h c o m m a n d s a n d m o v e a w a y f r o m m e s s a g e c o m m a n d s .
P a g i n a t o r w i t h S e l e c t M e n u a n d B u t t o n s : < b r >
< i m g s r c = " h t t p s : / / m e d i a . d i s c o r d a p p . n e t / a t t a c h m e n t s / 1 0 0 5 1 7 7 4 0 2 1 3 5 1 5 8 8 7 5 / 1 0 0 5 2 6 1 1 1 7 0 7 4 9 7 2 6 9 2 / u n k n o w n . p n g ? w i d t h = 6 6 9 & h e i g h t = 1 4 5 " > < / i m g >
# # # C o d e
j s
c o n s t { P a g i n a t o r , P a g e } = r e q u i r e ( ' @ j u s t n o b y 1 5 / d i s c o r d . j s - p a g i n a t o r ' ) ;
c o n s t { R E S T } = r e q u i r e ( ' @ d i s c o r d j s / r e s t ' ) ; / / P a g i n a t o r d o e s n o t s u p p o r t M e s s a g e O b j e c t s a s t o a d j u s t e v e r y o n e t o u s i n g D i s c o r d ' s s u g g e s t e d S l a s h C o m m a n d s .
c o n s t { C l i e n t , G a t e w a y I n t e n t B i t s , I n t e r a c t i o n T y p e , R o u t e s , E m b e d B u i l d e r } = r e q u i r e ( ' d i s c o r d . j s ' ) ;
c o n s t c l i e n t = n e w C l i e n t ( { i n t e n t s : [ G a t e w a y I n t e n t B i t s . G u i l d s ] } ) ;
c l i e n t . o n ( ' r e a d y ' , ( ) = > {
c o n s o l e . l o g ( L o g g e d i n a s $ { c l i e n t . u s e r . t a g } ! ) ;
c o n s t c o m m a n d s = [
{
n a m e : ' t e s t ' ,
d e s c r i p t i o n : ' t e s t f o r p r o p a c k a g e ' ,
} ,
] ;
c o n s t r e s t = n e w R E S T ( { v e r s i o n : ' 1 0 ' } ) . s e t T o k e n ( ' y o u r _ t o k e n _ m a y _ g o _ h e r e ' ) ;
( a s y n c ( ) = > {
t r y {
a w a i t r e s t . p u t ( R o u t e s . a p p l i c a t i o n C o m m a n d s ( c l i e n t . u s e r . i d ) , { b o d y : c o m m a n d s } ) ;
c o n s o l e . l o g ( ' S u c c e s s f u l l y r e g i s t e r e d c o m m a n d s . ' ) ;
} c a t c h ( e r r o r ) {
c o n s o l e . e r r o r ( e r r o r ) ;
}
} ) ( ) ;
} ) ;
c l i e n t . o n ( ' i n t e r a c t i o n C r e a t e ' , a s y n c ( i n t e r a c t i o n ) = > {
i f ( i n t e r a c t i o n . t y p e = = = I n t e r a c t i o n T y p e . A p p l i c a t i o n C o m m a n d ) {
i f ( i n t e r a c t i o n . c o m m a n d N a m e = = = " t e s t " ) {
c o n s t p a g e s = [
n e w P a g e ( " E m b e d 1 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " O n e " ) ) ,
n e w P a g e ( " E m b e d 2 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T w o " ) , " P a g e # 2 " ) ,
n e w P a g e ( " E m b e d 3 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T h r e e " ) , " P a g e # 3 " )
]
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 , { a u t h o r O n l y : f a l s e } ) ;
a w a i t p a g i n a t o r . r u n ( ) . c a t c h ( e r r = > c o n s o l e . l o g ( e r r ) ) ;
}
}
} ) ;
c l i e n t . l o g i n ( ' y o u r _ t o k e n _ c a n _ g o _ h e r e ' ) ;
# D o c u m e n t a t i o n
# # c l a s s P a g e
I n s t e a d o f u s i n g l i s t o f E m b e d s o f f e r e d b y d i s c o r d . j s , y o u u s e a l i s t o f P a g e s f r o m t h i s c l a s s .
# # # C o n s t r u c t o r
- t i t l e : s t r i n g | n u l l : D i s p l a y e d a s t h e p l a c e h o l d e r f o r s e l e c t M e n u
- e m b e d : E m b e d B u i l d e r | n u l l : A d i s c o r d . j s e m b e d
- c o n t e n t : s t r i n g | n u l l : T h e c o n t e n t o f t h e P a g e ( t h e m e s s a g e )
# # # M e t h o d s
- s e t T i t l e ( c o n t e n t : s t r i n g ) : S e t s t i t l e o f a p a g e
- s e t E m b e d ( e m b e d : E m b e d B u i l d e r ) : S e t s t h e e m b e d o f a p a g e
- s e t M e s s a g e C o n t e n t ( c o n t e n t : s t r i n g ) : S e t s t h e m e s s a g e c o n t e n t o f a p a g e
# # # # C o n s t r u c t o r E x a m p l e
j s
c o n s t p a g e s = [
n e w P a g e ( " E m b e d 1 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " O n e " ) ) ,
n e w P a g e ( " E m b e d 2 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T w o " ) , " P a g e # 2 " )
n e w P a g e ( " E m b e d 3 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T h r e e " ) , " P a g e # 3 " )
]
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( . . . , p a g e s , . . . ) ;
a w a i t p a g i n a t o r . r u n ( ) . c a t c h ( e r r = > c o n s o l e . l o g ( e r r ) ) ;
# # # # M e t h o d s E x a m p l e
j s
c o n s t p a g e s = [
n e w P a g e ( ) . s e t T i t l e ( " E m b e d 1 " ) . s e t E m b e d ( n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " O n e " ) ) ,
n e w P a g e ( ) . s e t T i t l e ( " E m b e d 2 " ) . s e t E m b e d ( n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T w o " ) ) . s e t M e s s a g e C o n t e n t ( " P a g e # 2 " ) ,
n e w P a g e ( ) . s e t T i t l e ( " E m b e d 3 " ) . s e t E m b e d ( n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T h r e e " ) ) . s e t M e s s a g e C o n t e n t ( " P a g e # 3 " )
]
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( . . . , p a g e s , . . . ) ;
# # c l a s s P a g i n a t o r
# # # A r g u m e n t s
- R e q u i r e d ( # r e q u i r e d )
- O p t i o n a l ( # o p t i o n a l )
- A t t r i b u t e s ( # a t t r i b u t e s )
- M e t h o d s ( # m e t h o d s )
# # # R e q u i r e d
- i n t e r a c t i o n : C a c h e T y p e : I n t e r a c t i o n O b j e c t
- e m b e d s : P a g e [ ] | [ ] : A l i s t o f e m b e d s
- U s e t h e P a g e c l a s s
- s e c o n d s : n u m b e r : S e c o n d s f o r c o l l e c t o r t i m e o u t
# # # O p t i o n a l
- o p t i o n s : O b j e c t : A n o b j e c t h o l d i n g f u r t h e r p a g i n a t o r o p t i o n s
- o p t i o n s . a u t h o r O n l y : b o o l e a n = t r u e : W h e t h e r t h e P a g i n a t o r r e s p o n d s t o t h e a u t h o r o r n o t
- o p t i o n s . u s e B u t t o n s : b o o l e a n = t r u e : W e t h e r t h e P a g i n a t o r h a s b u t t o n s
- o p t i o n s . u s e S e l e c t : b o o l e a n = t r u e : W h e t h e r t h e P a g i n a t o r h a s a s e l e c t m e n u
- o p t i o n s . d e f e r R e p l y : b o o l e a n = f a l s e : W h e t h e r t h e P a g i n a t o r d e f e r s i n i t i a l r e p l y
- o p t i o n s . e d i t R e p l y : b o o l e a n = f a l s e : W h e t h e r t h e P a g i n a t o r e d i t s t h e i n i t i a l i n t e r a c t i o n r e p l y
- o p t i o n s . d i s a b l e A f t e r T i m e o u t : b o o l e a n = t r u e : W h e t h e r t h e P a g i n a t o r d i s a b l e s a f t e r t h e t i m e o u t
- o p t i o n s . r e m o v e A f t e r T i m e o u t : b o o l e a n = f a l s e : W h e t h e r t h e P a g i n a t o r r e m o v e s b u t t o n s a f t e r t h e t i m e o u t
- o p t i o n s . d e l e t e A f t e r T i m e o u t : b o o l e a n = f a l s e : W h e t h e r t h e P a g i n a t o r d e l e t e s t h e m e s s a g e a f t e r t h e t i m e o u t
# # # M e t h o d s
- a d d P a g e s ( e m b e d s : P a g e | P a g e [ ] ) : A d d s t o e m b e d s o f P a g i n a t o r
j s
c o n s t p a g e s = [
n e w P a g e ( " E m b e d 1 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " O n e " ) ) ,
n e w P a g e ( " E m b e d 2 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T w o " ) , " P a g e # 2 " ) ,
n e w P a g e ( " E m b e d 3 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T h r e e " ) , " P a g e # 3 " )
]
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . a d d P a g e s ( n e w P a g e ( ) . s e t T i t l e ( " N e w e s t P a g e " ) . s e t E m b e d ( n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " F o u r " ) ) ) ;
- s e t P a g e s ( e m b e d s : P a g e [ ] ) : S e t s e m b e d s o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n ) . s e t P a g e s ( [
n e w P a g e ( " E m b e d 1 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " O n e " ) ) ,
n e w P a g e ( " E m b e d 2 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T w o " ) , " P a g e # 2 " ) ,
n e w P a g e ( " E m b e d 3 " , n e w E m b e d B u i l d e r ( ) . s e t D e s c r i p t i o n ( " T h r e e " ) , " P a g e # 3 " )
] ) . s e t S e c o n d s ( 1 5 ) ;
- s e t S e c o n d s ( s e c o n d s : n u m b e r ) : S e t s t i m e o f P a g i n a t o r i n s e c o n d s
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s ) . s e t S e c o n d s ( 1 5 ) ;
- s e t A u t h o r O n l y ( b o o l : b o o l e a n ) : S e t s a u t h o r O n l y o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t A u t h o r O n l y ( f a l s e ) ;
- s e t U s e B u t t o n s ( b o o l : b o o l e a n ) : S e t s u s e B u t t o n s o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t U s e B u t t o n s ( f a l s e ) ;
- s e t U s e S e l e c t ( b o o l : b o o l e a n ) : S e t s u s e S e l e c t o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t U s e S e l e c t ( f a l s e ) ;
- s e t D e f e r R e p l y ( b o o l : b o o l e a n ) : S e t s d e f e r R e p l y o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t D e f e r R e p l y ( t r u e ) ;
- s e t E d i t R e p l y ( b o o l : b o o l e a n ) : S e t s e d i t R e p l y o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t E d i t R e p l y ( t r u e ) ;
- s e t D i s a b l e A f t e r T i m e o u t ( b o o l : b o o l e a n ) : S e t s d i s a b l e A f t e r T i m e o u t o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t D i s a b l e A f t e r T i m e o u t ( f a l s e ) ;
- s e t R e m o v e A f t e r T i m e o u t ( b o o l : b o o l e a n ) : S e t s r e m o v e A f t e r T i m e o u t o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t R e m o v e A f t e r T i m e o u t ( t r u e ) ;
- s e t D e l e t e A f t e r T i m e o u t ( b o o l : b o o l e a n ) : S e t s d e l e t e A f t e r T i m e o u t o f P a g i n a t o r
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) . s e t D e l e t e A f t e r T i m e o u t ( t r u e ) ;
- f o r m a t O p t i o n s ( ) : F o r m a t s a l l t h e v a l u e s y o u p u t i n t o t h e o p t i o n s p a r a m e t e r . N e c e s s a r y f o r P a g i n a t o r p r o c e s s , h o w e v e r u s e r i s n o t i n q u i r e d t o u s e t h i s f u n c t i o n , t h e p a g i n a t o r a l r e a d y d o e s i t f o r y o u .
- W h a t d o e s i t d o e x a c t l y ? I t s i m p l y c h e c k s f o r u n d e f i n e d p r o p e r t i e s a n d s e t s t h e m t o d e f a u l t .
- a s y n c c o m p i l e E r r o r s ( ) : A f u n c t i o n t h a t c a t c h e s a l l e r r o r s y o u c o u l d h a v e b a s e d o n y o u r i n p u t s .
- R e t u r n s a P r o m i s e : T h i s i s s o u s e r s c o u l d c h e c k i f t h e r e P a g i n a t o r i n p u t s w e r e w r o n g b e f o r e r u n n i n g t h e b o t , b u t t h i s i s n o t r e q u i r e d a n d N O T r e c o m m e n d e d , b e c a u s e P a g i n a t o r d o e s i t f o r y o u . T h o u g h , y o u c a n u s e t h e s c r i p t l i k e t h i s n o w :
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 , { u s e B u t t o n s : f a l s e , u s e S e l e c t : f a l s e } ) ; / / T h e o p t i o n s t h r o w I n v a l i d B u i l d e r r o r
a w a i t p a g i n a t o r . c o m p i l e E r r o r s ( ) . c a t c h ( e r r = > c o n s o l e . l o g ( e r r ) ) . t h e n ( a s y n c ( ) = > a w a i t p a g i n a t o r . r u n ( ) ) ;
- a s y n c r u n ( ) : T h e P a g i n a t o r
- R e q u i r e d ( # r e q u i r e d )
- O p t i o n a l ( # o p t i o n a l )
- A t t r i b u t e s ( # a t t r i b u t e s )
- d a t a ( ) : R e t u r n s a l l P a g i n a t o r A t t r i b u t e s ( # a t t r i b u t e s )
# # # A t t r i b u t e s
D a t a y o u c a n a c c e s s u s i n g t h e P a g i n a t o r ' s d a t a ( ) f u n c t i o n .
j s
{
i n t e r a c t i o n : {
i n t e r a c t i o n T y p e : I n t e r a c t i o n T y p e ,
c l i e n t : C l i e n t ,
c h a n n e l : T e x t B a s e d C h a n n e l ,
u s e r : U s e r ,
g u i l d : G u i l d ,
c o m m a n d : C o m m a n d I n t e r a c t i o n | | n u l l ,
c r e a t e d A t : n u m b e r ,
i n t e r a c t i o n I d : s t r i n g
} ,
p a g i n a t o r : {
p a g e s : P a g e [ ] ,
t i m e : n u m b e r ,
m e s s a g e : M e s s a g e ,
a u t h o r O n l y : b o o l e a n ,
u s e B u t t o n s : b o o l e a n ,
u s e S e l e c t : b o o l e a n ,
d e f e r R e p l y : b o o l e a n ,
e d i t R e p l y : b o o l e a n ,
d i s a b l e A f t e r T i m e o u t : b o o l e a n ,
r e m o v e A f t e r T i m e o u t : b o o l e a n ,
d e l e t e A f t e r T i m e o u t : b o o l e a n
m e s s a g e I d : s t r i n g
}
}
j s
c o n s t p a g i n a t o r = n e w P a g i n a t o r ( i n t e r a c t i o n , p a g e s , 1 5 ) ;
c o n s o l e . l o g ( p a g i n a t o r . d a t a ( ) ) ;
# # C r e d i t s
- d i s c o r d - j s ( h t t p s : / / w w w . n p m j s . c o m / p a c k a g e / d i s c o r d . j s )
- T o r i c a n e ' s i n t e r a c t i o n s . p y / P a g i n a t o r ( h t t p s : / / g i t h u b . c o m / i n t e r a c t i o n s - p y / p a g i n a t o r )
- K r a z y D e v e l o p e r ' s D i s c o r d P a g i n a t o r T u t o r i a l ( h t t p s : / / w w w . y o u t u b e . c o m / w a t c h ? v = a d H o O i 6 z G m E & a b _ c h a n n e l = K r a z y D e v e l o p e r )
B a c k t o t o p ( # t o p )