Kiai Docs - Leveling

Extends

BaseHandler

Constructors

Constructor

new Leveling(handler): Leveling

Parameters

Parameter	Type
`handler`	`RequestHandler`

Returns

Leveling

Inherited from

BaseHandler.constructor

Properties

Property	Modifier	Type	Inherited from
`_handler`	`public`	`RequestHandler`	`BaseHandler._handler`

Methods

addXp()

addXp(guildId, userId, xp): Promise<SuccessResponse>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`xp`	`number`

Returns

Promise<SuccessResponse>

getLeaderboard()

getLeaderboard(guildId, optionsOrStart?, legacyEnd?): Promise<Leaderboard>

Parameters

Parameter	Type
`guildId`	`string`
`optionsOrStart?`	`number` \| `LeaderboardOptions`
`legacyEnd?`	`number`

Returns

Promise<Leaderboard>

getMember()

getMember(guildId, userId): Promise<LevelData | null>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

Promise<LevelData | null>

getStats()

getStats(guildId): Promise<GuildStats>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<GuildStats>

prestige()

prestige(guildId, userId): Promise<PrestigeResponse>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

Promise<PrestigeResponse>

removeXp()

removeXp(guildId, userId, xp): Promise<SuccessResponse>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`xp`	`number`

Returns

Promise<SuccessResponse>

setXp()

setXp(guildId, userId, xp): Promise<SuccessResponse>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`xp`	`number`

Returns

Promise<SuccessResponse>