Class MongooseStorageAdapter

Production-ready Mongoose persistence adapter with single-roundtrip aggregations, connection sharing, and atomic bonus counters.

Implements

StorageAdapter

Index

Constructors

Methods

addBonus close getBonus getLeaderboard getMemberStats init isFakeRejoin recordJoin recordLeave

Constructors

constructor

new MongooseStorageAdapter(
options: MongooseStorageOptions,
): MongooseStorageAdapter
Parameters
- options: MongooseStorageOptions
Returns MongooseStorageAdapter
- Defined in src/storage/mongooseAdapter.ts:33

Methods

addBonus

addBonus(guildId: string, userId: string, amount: number): Promise<number>
Add or subtract bonus invites for a user in a guild.
Parameters
- guildId: string
- userId: string
- amount: number
Returns Promise<number>
Implementation of StorageAdapter.addBonus
- Defined in src/storage/mongooseAdapter.ts:233

close

close(): Promise<void>
Optional lifecycle hook to close database connections upon teardown.

Returns Promise<void>
Implementation of StorageAdapter.close
- Defined in src/storage/mongooseAdapter.ts:275

getBonus

getBonus(guildId: string, userId: string): Promise<number>
Get current bonus invites for a user in a guild.
Parameters
- guildId: string
- userId: string
Returns Promise<number>
Implementation of StorageAdapter.getBonus
- Defined in src/storage/mongooseAdapter.ts:245

getLeaderboard

getLeaderboard(
guildId: string,
limit?: number,
): Promise<{ stats: MemberInviteStats; userId: string }[]>
Fetch top inviters for a guild ordered by net valid invites.
Parameters
- guildId: string
- limit: number = 10
Returns Promise<{ stats: MemberInviteStats; userId: string }[]>
Implementation of StorageAdapter.getLeaderboard
- Defined in src/storage/mongooseAdapter.ts:164

getMemberStats

getMemberStats(guildId: string, userId: string): Promise<MemberInviteStats>
Fetch cumulative invite statistics for a user in a guild.
Parameters
- guildId: string
- userId: string
Returns Promise<MemberInviteStats>
Implementation of StorageAdapter.getMemberStats
- Defined in src/storage/mongooseAdapter.ts:126

init

init(): Promise<void>
Optional lifecycle hook to initialize the storage connection.

Returns Promise<void>
Implementation of StorageAdapter.init
- Defined in src/storage/mongooseAdapter.ts:43

isFakeRejoin

isFakeRejoin(
    guildId: string,
    inviteeId: string,
    thresholdMs: number,
): Promise<boolean>
Check whether a user recently left this guild within the specified threshold milliseconds.
Parameters
- guildId: string
- inviteeId: string
- thresholdMs: number
Returns Promise<boolean>
Implementation of StorageAdapter.isFakeRejoin
- Defined in src/storage/mongooseAdapter.ts:250

recordJoin

recordJoin(record: Omit<InviteRecord, "leftAt">): Promise<InviteRecord>
Record a member join event.
Parameters
- record: Omit<InviteRecord, "leftAt">
Returns Promise<InviteRecord>
Implementation of StorageAdapter.recordJoin
- Defined in src/storage/mongooseAdapter.ts:76

recordLeave

recordLeave(guildId: string, inviteeId: string): Promise<InviteRecord | null>
Record a member leave event by updating the latest active join record.
Parameters
- guildId: string
- inviteeId: string
Returns Promise<InviteRecord | null>
Implementation of StorageAdapter.recordLeave
- Defined in src/storage/mongooseAdapter.ts:101