Class Leveling

Hierarchy

Database
- Leveling

Index

Constructors

constructor

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

Properties

`Private` #events

#events: EventEmitter<string | symbol, any> = ...

`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

`Private` 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:39

Methods

`Private` #connect

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

getOptions

getOptions(options, user, member): Promise<object>
Parameters
- options: Options
- user: Users
- member: GuildMember
Returns Promise<object>
- Defined in src/index.ts:416

guildMemberRemove

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

handleLevelups

handleLevelups(member, currentChannel, xp, db?, voiceMinutes?, isLevelup?): Promise<undefined | null>
This is only for internal use!
Parameters
- member: GuildMember
- currentChannel: null | TextBasedChannel
- xp: number
- Optional db: null | CachedOptions<Settings>
- Optional voiceMinutes: number
- Optional isLevelup: null | boolean
Returns Promise<undefined | null>
- Defined in src/index.ts:439

messageCreate

messageCreate(message): Promise<undefined | null>
Parameters
- message: Message<boolean>
Returns Promise<undefined | null>
- Defined in src/index.ts:264

onCooldown

onCooldown(listener): EventEmitter<string | symbol, any>
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 EventEmitter<string | symbol, any>
- Defined in src/index.ts:65

onLevelUp

onLevelUp(listener): EventEmitter<string | symbol, any>
Emits when someone levels up in a server.
Parameters
- listener: ((member, profile, server, level, channel) => unknown)
  - - (member, profile, server, level, channel): unknown
    - Parameters
      member: GuildMember
      profile: Users & {
      _id: string;
      }
      server: Settings & {
      _id: string;
      }
      level: number
      channel: null | GuildChannel
      Returns unknown
Returns EventEmitter<string | symbol, any>
- Defined in src/index.ts:73

onXP

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

`Private` send

send(db, channel, channelId, options): Promise<null | void | Message<true> | APIMessage>
Parameters
- db: Settings
- channel: TextBasedChannel
- channelId: string
- options: sendOptions
Returns Promise<null | void | Message<true> | APIMessage>
- Defined in src/index.ts:85

sendOptions

sendOptions(user, db, member, options, channel): Promise<null | void | Message<true> | APIMessage>
Parameters
- user: Users
- db: Settings
- member: GuildMember
- options: Options
- channel: TextBasedChannel
Returns Promise<null | void | Message<true> | APIMessage>
- Defined in src/index.ts:393

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:134

voiceStateUpdate

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

`Private` webhook

webhook(guild): GuildWebhook
Parameters
- guild: Guild
Returns GuildWebhook
- Defined in src/index.ts:58

Class Leveling

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client<boolean>

mongodbURI: string

dbName: string = "Leveling"

Returns Leveling

Properties

Private #events

Private #listening

Private #url

api

client

dbs

Type declaration

Accessors

Private 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<void>

getOptions

Parameters

options: Options

user: Users

member: GuildMember

Returns Promise<object>

guildMemberRemove

Parameters

m: GuildMember | PartialGuildMember

Returns Promise<void>

handleLevelups

Parameters

member: GuildMember

currentChannel: null | TextBasedChannel

xp: number

Optional db: null | CachedOptions<Settings>

Optional voiceMinutes: number

Optional isLevelup: null | boolean

Returns Promise<undefined | null>

messageCreate

Parameters

message: Message<boolean>

Returns Promise<undefined | null>

onCooldown

Parameters

listener: ((message, cooldown) => unknown)

Parameters

message: Message<true>

cooldown: UserCache

Returns unknown

Returns EventEmitter<string | symbol, any>

onLevelUp

Parameters

listener: ((member, profile, server, level, channel) => unknown)

Parameters

member: GuildMember

profile: Users & { _id: string; }

server: Settings & { _id: string; }

level: number

channel: null | GuildChannel

Returns unknown

Returns EventEmitter<string | symbol, any>

`Private` #events

`Private` #listening

`Private` #url

`Private` 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;
}>)

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

`Optional` db: null | CachedOptions<Settings>

`Optional` voiceMinutes: number

`Optional` isLevelup: null | boolean

profile: Users & {
_id: string;
}

server: Settings & {
_id: string;
}

profile: Users & {
_id: string;
}

server: Settings & {
_id: string;
}

`Private` send

`Private` webhook