Class Leveling

Hierarchy

Database
- Leveling

Index

Constructors

constructor

new Leveling(client, mongodbURI): Leveling
Parameters
- client: Client<boolean>
- mongodbURI: string
Returns Leveling
Overrides Database.constructor
- Defined in src/index.ts:35

Properties

`Private` #cache

#cache: Map<string, UserCache> = ...

Internal cache for user cooldowns

`Private` #events

#events: __module = ...

`Private` #listening

#listening: boolean = false

A boolean to make sure the package only listens to the events ONCE

`Private` #url

#url: string

api

api: API = ...

The manager to configure the leveling data ()

client

client: Client<boolean>

dbs

dbs: {
    settings: Model<Settings, {}, {}, {}, Document<unknown, {}, Settings> & Settings & {
        _id: ObjectId;
    }, Schema<Settings, Model<Settings, any, any, any, Document<unknown, any, Settings> & Settings & {
        _id: ObjectId;
    }, any>, {}, {}, {}, {}, DefaultSchemaOptions, Settings, Document<unknown, {}, FlatRecord<Settings>> & FlatRecord<Settings> & {
        _id: ObjectId;
    }>>;
    users: Model<Users, {}, {}, {}, Document<unknown, {}, Users> & Users & {
        _id: ObjectId;
    }, Schema<Users, Model<Users, any, any, any, Document<unknown, any, Users> & Users & {
        _id: ObjectId;
    }, any>, {}, {}, {}, {}, DefaultSchemaOptions, Users, Document<unknown, {}, FlatRecord<Users>> & FlatRecord<Users> & {
        _id: ObjectId;
    }>>;
    weekly: Model<Weekly, {}, {}, {}, Document<unknown, {}, Weekly> & Weekly & {
        _id: ObjectId;
    }, Schema<Weekly, Model<Weekly, any, any, any, Document<unknown, any, Weekly> & Weekly & {
        _id: ObjectId;
    }, any>, {}, {}, {}, {}, DefaultSchemaOptions, Weekly, Document<unknown, {}, FlatRecord<Weekly>> & FlatRecord<Weekly> & {
        _id: ObjectId;
    }>>;
} = ...

Type declaration

settings: Model<Settings, {}, {}, {}, Document<unknown, {}, Settings> & Settings & {
    _id: ObjectId;
}, Schema<Settings, Model<Settings, any, any, any, Document<unknown, any, Settings> & Settings & {
    _id: ObjectId;
}, any>, {}, {}, {}, {}, DefaultSchemaOptions, Settings, Document<unknown, {}, FlatRecord<Settings>> & FlatRecord<Settings> & {
    _id: ObjectId;
}>>
users: Model<Users, {}, {}, {}, Document<unknown, {}, Users> & Users & {
    _id: ObjectId;
}, Schema<Users, Model<Users, any, any, any, Document<unknown, any, Users> & Users & {
    _id: ObjectId;
}, any>, {}, {}, {}, {}, DefaultSchemaOptions, Users, Document<unknown, {}, FlatRecord<Users>> & FlatRecord<Users> & {
    _id: ObjectId;
}>>
weekly: Model<Weekly, {}, {}, {}, Document<unknown, {}, Weekly> & Weekly & {
    _id: ObjectId;
}, Schema<Weekly, Model<Weekly, any, any, any, Document<unknown, any, Weekly> & Weekly & {
    _id: ObjectId;
}, any>, {}, {}, {}, {}, DefaultSchemaOptions, Weekly, Document<unknown, {}, FlatRecord<Weekly>> & FlatRecord<Weekly> & {
    _id: ObjectId;
}>>

Accessors

cache

get cache(): {
    clear: {
        server: ((guildId) => boolean[]);
        user: ((userId, guildId) => boolean);
    };
}
Returns {
    clear: {
        server: ((guildId) => boolean[]);
        user: ((userId, guildId) => boolean);
    };
}
- clear: {
  server: ((guildId) => boolean[]);
  user: ((userId, guildId) => boolean);
  }
  - server: ((guildId) => boolean[])
    - - (guildId): boolean[]
      - Delete all users from a server's cooldown
        
        Parameters
        
        guildId: string
        
        Returns boolean[]
  - user: ((userId, guildId) => boolean)
    - - (userId, guildId): boolean
      - Delete a user from a server's cooldown.
        
        Parameters
        
        userId: string
        
        guildId: string
        
        Returns boolean
- Defined in src/index.ts:73

weekly

get weekly(): {
    add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
        _id: ObjectId;
    }>);
    get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
        _id: ObjectId;
    }>);
}
Returns {
    add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
        _id: ObjectId;
    }>);
    get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
        _id: ObjectId;
    }>);
}
- add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
  _id: ObjectId;
  }>)
  - - (guildId, data): Promise<null | Document<unknown, {}, Weekly> & Weekly & {
      _id: ObjectId;
      }>
    - Parameters
      
      guildId: string
      
      data: WeeklyData
      Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & {
      _id: ObjectId;
      }>
- get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
  _id: ObjectId;
  }>)
  - - (guildId, id?): Promise<null | Document<unknown, {}, Weekly> & Weekly & {
      _id: ObjectId;
      }>
    - Parameters
      
      guildId: string
      
      Optional id: string
      Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & {
      _id: ObjectId;
      }>
Inherited from Database.weekly
- Defined in src/services/index.ts:22

Methods

`Private` #connect

#connect(): undefined | Promise<__module>
Returns undefined | Promise<__module>
Inherited from Database.#connect
- Defined in src/services/index.ts:157

`Private` #guildMemberRemove

#guildMemberRemove(m): Promise<void>
Parameters
- m: GuildMember | PartialGuildMember
Returns Promise<void>
- Defined in src/index.ts:205

`Private` #handleLevelups

#handleLevelups(member, currentChannel, xp, db, voiceMinutes?): Promise<void>
Parameters
- member: GuildMember
- currentChannel: null | TextBasedChannel
- xp: number
- db: CachedOptions<Settings>
- Optional voiceMinutes: number
Returns Promise<void>
- Defined in src/index.ts:307

`Private` #messageCreate

#messageCreate(message): Promise<void>
Parameters
- message: Message<boolean>
Returns Promise<void>
- Defined in src/index.ts:216

`Private` #voiceStateUpdate

#voiceStateUpdate(old, voice): Promise<void>
Parameters
- old: VoiceState
- voice: VoiceState
Returns Promise<void>
- Defined in src/index.ts:114

getSettings

getSettings(guildId): Promise<null | Document<unknown, {}, Settings> & Settings & {
_id: ObjectId;
}>
Parameters
- guildId: string
Returns Promise<null | Document<unknown, {}, Settings> & Settings & {
_id: ObjectId;
}>
Inherited from Database.getSettings
- Defined in src/services/index.ts:142

getUser

getUser(userId, guildId): Promise<null | Document<unknown, {}, Users> & Users & {
_id: ObjectId;
}>
Parameters
- userId: string
- guildId: string
Returns Promise<null | Document<unknown, {}, Users> & Users & {
_id: ObjectId;
}>
Inherited from Database.getUser
- Defined in src/services/index.ts:127

handleWeeklyAnnounce

handleWeeklyAnnounce(data): Promise<undefined | null | Message<true> | Message<false>>
Parameters
- data: Weekly
Returns Promise<undefined | null | Message<true> | Message<false>>
Inherited from Database.handleWeeklyAnnounce
- Defined in src/services/index.ts:169

onCooldown

onCooldown(listener): __module
Emits when the cooldown is added for the user
Parameters
- listener: ((message, cooldown) => unknown)
  - - (message, cooldown): unknown
    - Parameters
      
      message: Message<true>
      
      cooldown: UserCache
      
      Returns unknown
Returns __module
- Defined in src/index.ts:42

onLevelUp

onLevelUp(listener): __module
Emits when someone levels up in a server.
Parameters
- listener: ((member, profile, server) => unknown)
  - - (member, profile, server): unknown
    - Parameters
      
      member: GuildMember
      
      profile: Users & {
      _id: string;
      }
      
      server: Settings & {
      _id: string;
      }
      
      Returns unknown
Returns __module
- Defined in src/index.ts:50

onXP

onXP(listener): __module
Emits when someone gains xp in a server.
Parameters
- listener: ((member, profile, server) => unknown)
  - - (member, profile, server): unknown
    - Parameters
      
      member: GuildMember
      
      profile: Users & {
      _id: string;
      }
      
      server: Settings & {
      _id: string;
      }
      
      Returns unknown
Returns __module
- Defined in src/index.ts:63

start

start(): Promise<undefined | true>
Use this to start listening for events and automatically handle xp/leveling

Returns Promise<undefined | true>
- Defined in src/index.ts:97

Class Leveling

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client<boolean>

mongodbURI: string

Returns Leveling

Properties

Private #cache

Private #events

Private #listening

Private #url

api

client

dbs

Type declaration

Accessors

cache

Returns { clear: { server: ((guildId) => boolean[]); user: ((userId, guildId) => boolean); }; }

clear: { server: ((guildId) => boolean[]); user: ((userId, guildId) => boolean); }

server: ((guildId) => boolean[])

Parameters

guildId: string

Returns boolean[]

user: ((userId, guildId) => boolean)

Parameters

userId: string

guildId: string

Returns boolean

weekly

Returns { add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>); get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>); }

add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>)

Parameters

guildId: string

data: WeeklyData

Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>

get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>)

Parameters

guildId: string

Optional id: string

Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & { _id: ObjectId; }>

Methods

Private #connect

Returns undefined | Promise<__module>

Private #guildMemberRemove

Parameters

m: GuildMember | PartialGuildMember

Returns Promise<void>

Private #handleLevelups

Parameters

member: GuildMember

currentChannel: null | TextBasedChannel

xp: number

db: CachedOptions<Settings>

Optional voiceMinutes: number

Returns Promise<void>

Private #messageCreate

Parameters

message: Message<boolean>

Returns Promise<void>

Private #voiceStateUpdate

Parameters

old: VoiceState

voice: VoiceState

Returns Promise<void>

getSettings

Parameters

guildId: string

Returns Promise<null | Document<unknown, {}, Settings> & Settings & { _id: ObjectId; }>

getUser

Parameters

userId: string

guildId: string

Returns Promise<null | Document<unknown, {}, Users> & Users & { _id: ObjectId; }>

`Private` #cache

`Private` #events

`Private` #listening

`Private` #url

Returns {
clear: {
server: ((guildId) => boolean[]);
user: ((userId, guildId) => boolean);
};
}

clear: {
server: ((guildId) => boolean[]);
user: ((userId, guildId) => boolean);
}

Returns {
add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>);
get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>);
}

add: ((guildId, data) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>)

Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>

get: ((guildId, id?) => Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>)

`Optional` id: string

Returns Promise<null | Document<unknown, {}, Weekly> & Weekly & {
_id: ObjectId;
}>

`Private` #connect

`Private` #guildMemberRemove

`Private` #handleLevelups

`Optional` voiceMinutes: number

`Private` #messageCreate

`Private` #voiceStateUpdate

Returns Promise<null | Document<unknown, {}, Settings> & Settings & {
_id: ObjectId;
}>

Returns Promise<null | Document<unknown, {}, Users> & Users & {
_id: ObjectId;
}>

profile: Users & {
_id: string;
}

server: Settings & {
_id: string;
}

profile: Users & {
_id: string;
}

server: Settings & {
_id: string;
}