Skip to content

Commit

Permalink
Merge pull request #4 from Lioness100/master
Browse files Browse the repository at this point in the history
Added typings
  • Loading branch information
rjt-rockx committed Mar 29, 2021
2 parents 572464b + 0fca254 commit 5023b6c
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
47 changes: 47 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
interface IdentifierObject {
id: string;
}

type Identifier = IdentifierObject | string;

interface Role {
color: number;
hoist: boolean;
id: string;
managed: boolean;
mentionable: boolean;
name: string;
permissions: number;
position: number;
}

interface Reward {
role: Role;
level: number;
}

interface XPInfo {
userXp: number;
levelXp: number;
totalXp: number;
}

interface User {
id: string;
level: number;
username: string;
discriminator: string;
avatarUrl: string;
messageCount: number;
tag: string;
xp: XPInfo;
rank: number;
}

export default class Mee6LevelsApi {
private static getId(guildOrUser: Identifier): string;
public static async getRoleRewards(guild: Identifier): Promise<Reward[]>;
public static async getLeaderboardPage(guild: Identifier, limit?: number, page?: number): Promise<User[]>;
public static async getLeaderboard(guild: Identifier): Promise<User[]>;
public static async getUserXp(guild: Identifier, user: Identifier): Promise<User | undefined>;
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "1.2.0",
"description": "An API wrapper for Mee6 levels",
"main": "index.js",
"types": "index.d.ts",
"repository": {
"type": "git",
"url": "git+https://github.com/rjt-rockx/mee6-levels-api.git"
Expand Down

0 comments on commit 5023b6c

Please sign in to comment.