Constructors
constructor
new API ( client ) : API
Returns API
Accessors
servers
get servers( ) : { announce : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , type , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; cooldown : ( ( guildId , seconds ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; delete : ( ( guildId ) => Promise < { data : { data : null | CachedOptions < Settings > ; users : CachedOptions < Users > [] ; weekly : CachedOptions < Weekly > [] ; } ; message : string ; status : boolean ; } > ) ; fetchAll : ( ( guildIds ? ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Settings > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Settings & { _id : ObjectId ; } > ; status : true ; } > ) ; ignore : { channels : ( ( guildId , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; users : ( ( guildId , users ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; import : ( ( guildId , targetGuildId , type ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; leaderboard : { formatted : ( < D > ( guildId , options ? , forceStatic ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > ) ; get : ( < D > ( guildId , options ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardUser [] > > ) ; setBackground : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; levels : { add : ( ( guildId , level , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; addRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; removeRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , options , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; multipliers : { add : ( ( guildId , multiplier , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; channels : ( ( guildId , multiplier , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , multiplier ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , multiplier , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; setXP : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; weekly : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setRoles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; }
Returns { announce : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , type , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; cooldown : ( ( guildId , seconds ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; delete : ( ( guildId ) => Promise < { data : { data : null | CachedOptions < Settings > ; users : CachedOptions < Users > [] ; weekly : CachedOptions < Weekly > [] ; } ; message : string ; status : boolean ; } > ) ; fetchAll : ( ( guildIds ? ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Settings > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Settings & { _id : ObjectId ; } > ; status : true ; } > ) ; ignore : { channels : ( ( guildId , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; users : ( ( guildId , users ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; import : ( ( guildId , targetGuildId , type ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; leaderboard : { formatted : ( < D > ( guildId , options ? , forceStatic ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > ) ; get : ( < D > ( guildId , options ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardUser [] > > ) ; setBackground : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; levels : { add : ( ( guildId , level , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; addRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; removeRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , options , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; multipliers : { add : ( ( guildId , multiplier , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; channels : ( ( guildId , multiplier , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , multiplier ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , multiplier , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; setXP : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; weekly : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setRoles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; }
announce : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , type , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
set Channel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , channelId ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
channelId : string
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
set Message : ( ( guildId , type , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , type , options ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
type : "channel" | "dm"
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , type ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
type : "channel" | "dm" | "ping" | "onlyRegisteredLevels"
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
cooldown : ( ( guildId , seconds ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , seconds ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
seconds : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
delete : ( ( guildId ) => Promise < { data : { data : null | CachedOptions < Settings > ; users : CachedOptions < Users > [] ; weekly : CachedOptions < Weekly > [] ; } ; message : string ; status : boolean ; } > )
fetch All : ( ( guildIds ? ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Settings > & { _id : ObjectId ; } ) [] ; status : true ; } > )
( guildIds ? ) : Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Settings > & { _id : ObjectId ; } ) [] ; status : true ; } >
Parameters
Optional
guildIds : string []
Returns Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Settings > & { _id : ObjectId ; } ) [] ; status : true ; } >
get : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Settings & { _id : ObjectId ; } > ; status : true ; } > )
( guildId ) : Promise < { message : string ; status : false ; } | { data : FlattenMaps < Settings & { _id : ObjectId ; } > ; status : true ; } >
Returns Promise < { message : string ; status : false ; } | { data : FlattenMaps < Settings & { _id : ObjectId ; } > ; status : true ; } >
ignore : { channels : ( ( guildId , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; users : ( ( guildId , users ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
channels : ( ( guildId , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , channels ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
channels : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
roles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , roles ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
roles : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
users : ( ( guildId , users ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , users ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
users : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
import : ( ( guildId , targetGuildId , type ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , targetGuildId , type ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
targetGuildId : string
type : "mee6" | "amari" = "amari"
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
leaderboard : { formatted : ( < D > ( guildId , options ? , forceStatic ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > ) ; get : ( < D > ( guildId , options ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardUser [] > > ) ; setBackground : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
formatted : ( < D > ( guildId , options ? , forceStatic ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > )
get : ( < D > ( guildId , options ? , board ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardUser [] > > )
set Background : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , options ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
options : { color ?: null | string ; url ?: null | string ; }
Optional
color ?: null | string
Optional
url ?: null | string
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
levels : { add : ( ( guildId , level , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; addRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; removeRoles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setMessage : ( ( guildId , options , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
add : ( ( guildId , level , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , level , options ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
level : number
Optional
options : { add ?: string [] ; options ?: OptionalOptions ; remove ?: string [] ; }
Optional
add ?: string []
Optional
remove ?: string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
add Roles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , level , roles ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
level : number
roles : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
remove : ( ( guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , level ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
level : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
remove Roles : ( ( guildId , level , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , level , roles ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
level : number
roles : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
set Message : ( ( guildId , options , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , options , level ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
level : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
multipliers : { add : ( ( guildId , multiplier , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; channels : ( ( guildId , multiplier , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; remove : ( ( guildId , multiplier ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; roles : ( ( guildId , multiplier , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
add : ( ( guildId , multiplier , options ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , multiplier , options ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
multiplier : number
Optional
options : { channels ?: string [] ; roles ?: string [] ; }
Optional
channels ?: string []
Optional
roles ?: string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
channels : ( ( guildId , multiplier , channels ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , multiplier , channels ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
multiplier : number
channels : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
remove : ( ( guildId , multiplier ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , multiplier ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
multiplier : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
roles : ( ( guildId , multiplier , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , multiplier , roles ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
multiplier : number
roles : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
setXP : ( ( guildId , options ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , options ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
options : { max ?: number ; min ?: number ; }
Optional
max ?: number
Optional
min ?: number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
toggle : ( ( guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , type ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
weekly : { setChannel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setRoles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
set Channel : ( ( guildId , channelId ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , channelId ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
channelId : string
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
set Roles : ( ( guildId , roles ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( guildId , roles ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
roles : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
users
get users( ) : { appendXP : ( ( userId , guildId , xp , voiceMinutes ? ) => Promise < null | boolean > ) ; create : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > ) ; delete : { all : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > ) ; guild : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } > ) ; } ; fetchAll : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > ) ; position : ( ( userId , guildId , sort ? ) => Promise < number > ) ; purge : ( ( dry ? , users ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > ) ; setBackground : ( ( userId , guildId , background ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setColor : ( ( userId , guildId , type , color ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setLevel : ( ( userId , guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setXP : ( ( userId , guildId , xp ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; stats : { dec : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; inc : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; toggle : ( ( userId , guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
Returns { appendXP : ( ( userId , guildId , xp , voiceMinutes ? ) => Promise < null | boolean > ) ; create : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > ) ; delete : { all : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > ) ; guild : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } > ) ; } ; fetchAll : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > ) ; position : ( ( userId , guildId , sort ? ) => Promise < number > ) ; purge : ( ( dry ? , users ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > ) ; setBackground : ( ( userId , guildId , background ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setColor : ( ( userId , guildId , type , color ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setLevel : ( ( userId , guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; setXP : ( ( userId , guildId , xp ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; stats : { dec : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; inc : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; } ; toggle : ( ( userId , guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
appendXP : ( ( userId , guildId , xp , voiceMinutes ? ) => Promise < null | boolean > )
( userId , guildId , xp , voiceMinutes ? ) : Promise < null | boolean >
Parameters
userId : string
guildId : string
xp : number
Optional
voiceMinutes : number
Returns Promise < null | boolean >
create : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > )
( userId , guildId ) : Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } >
Parameters
userId : string
guildId : string
Returns Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } >
delete : { all : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > ) ; guild : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } > ) ; }
all : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > )
( userId ) : Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } >
Returns Promise < { message : string ; status : false ; } | { data : never [] | ( Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } >
guild : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } > )
( userId , guildId ) : Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } >
Parameters
userId : string
guildId : string
Returns Promise < { message : string ; status : false ; } | { data : Document < unknown , {} , Users > & Users & { _id : ObjectId ; } ; message : string ; status : boolean ; } >
fetch All : ( ( userId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; status : true ; } > )
( userId ) : Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; status : true ; } >
Returns Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; status : true ; } >
get : ( ( userId , guildId ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } > )
( userId , guildId ) : Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } >
Parameters
userId : string
guildId : string
Returns Promise < { message : string ; status : false ; } | { data : FlattenMaps < Users & { _id : ObjectId ; } > ; status : true ; } >
position : ( ( userId , guildId , sort ? ) => Promise < number > )
( userId , guildId , sort ? ) : Promise < number >
Parameters
userId : string
guildId : string
Optional
sort : "ascending" | "descending"
Returns Promise < number >
purge : ( ( dry ? , users ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } > )
( dry ? , users ) : Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } >
Parameters
dry : boolean = true
users : string []
Returns Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Users > & { _id : ObjectId ; } ) [] ; message : string ; status : boolean ; } >
set Background : ( ( userId , guildId , background ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , background ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
Optional
background : string
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
set Color : ( ( userId , guildId , type , color ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , type , color ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
Optional
color : string | number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
set Level : ( ( userId , guildId , level ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , level ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
level : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
setXP : ( ( userId , guildId , xp ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , xp ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
xp : number
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
stats : { dec : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; inc : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > ) ; }
dec : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , type , count ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
type : string
count : number = 1
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
inc : ( ( userId , guildId , type , count ? ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , type , count ? ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
type : string
count : number = 1
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
toggle : ( ( userId , guildId , type ) => Promise < { message : string ; status : false ; } | { message : string ; status : true ; } > )
( userId , guildId , type ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
userId : string
guildId : string
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
weekly
get weekly( ) : { fetchAll : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Weekly > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( guildId , weeklyId ? ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Weekly & { _id : ObjectId ; } > ; status : true ; } > ) ; leaderboard : ( ( guildId , weeklyId ? , options ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > ) ; }
Returns { fetchAll : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Weekly > & { _id : ObjectId ; } ) [] ; status : true ; } > ) ; get : ( ( guildId , weeklyId ? ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Weekly & { _id : ObjectId ; } > ; status : true ; } > ) ; leaderboard : ( ( guildId , weeklyId ? , options ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > ) ; }
fetch All : ( ( guildId ) => Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Weekly > & { _id : ObjectId ; } ) [] ; status : true ; } > )
( guildId ) : Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Weekly > & { _id : ObjectId ; } ) [] ; status : true ; } >
Returns Promise < { message : string ; status : false ; } | { data : never [] | ( FlattenMaps < Weekly > & { _id : ObjectId ; } ) [] ; status : true ; } >
get : ( ( guildId , weeklyId ? ) => Promise < { message : string ; status : false ; } | { data : FlattenMaps < Weekly & { _id : ObjectId ; } > ; status : true ; } > )
( guildId , weeklyId ? ) : Promise < { message : string ; status : false ; } | { data : FlattenMaps < Weekly & { _id : ObjectId ; } > ; status : true ; } >
Parameters
guildId : string
Optional
weeklyId : string
Returns Promise < { message : string ; status : false ; } | { data : FlattenMaps < Weekly & { _id : ObjectId ; } > ; status : true ; } >
leaderboard : ( ( guildId , weeklyId ? , options ? ) => Promise < { message : string ; status : false ; } | LeaderboardFormattedResponse < LeaderboardFormatted [] > > )
Methods
Private
#handle Ignore
#handle Ignore ( guildId , type , arr ) : Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
Parameters
guildId : string
type : "roles" | "channels" | "users"
arr : string []
Returns Promise < { message : string ; status : false ; } | { message : string ; status : true ; } >
get Leaderboard
get Leaderboard ( guildId , options ? , type ? , isWeekly ? ) : CanvasResponseWithQuery
Parameters
guildId : string
Optional
options : Omit < LeaderboardCanvasOptions , "background" | "backgroundColor" >
type : "canvacord" = "canvacord"
isWeekly : boolean = false
get Rank Card
get Rank Card ( userId , guildId , type ? ) : CanvasResponse
Parameters
userId : string
guildId : string
Set/Reset the announcement channel for level ups.