CooldownManager

class

CooldownManager

source
export class CooldownManager<A extends BaseCooldownAdapter>
export class CooldownManager<A extends BaseCooldownAdapter>
constructor(client: Client, adapter: A, options?: CooldownManager.Options|undefined)
constructor(client: Client, adapter: A, options?: CooldownManager.Options|undefined)
ParamTypeRequired
client
client
Client
Client
Yes
adapter
adapter
A
A
Yes
options
options
CooldownManager.Options|undefined
CooldownManager.Options|undefined
No
fetch(id: string, options: { force: boolean; }): Promise<Cooldown.Data|null>
fetch(id: string, options: { force: boolean; }): Promise<Cooldown.Data|null>
ParamTypeRequired
id
id
string
string
Yes
options
options
{ force: boolean; }
{ force: boolean; }
Yes

Returns:

Promise<Cooldown.Data|null>
Promise<Cooldown.Data|null>

fetchForUser(user: UserResolvable, options?: Partial<Pick<Cooldown.Data, "guildId"|"channelId"|"trigger">>): Promise<Cooldown[]>
fetchForUser(user: UserResolvable, options?: Partial<Pick<Cooldown.Data, "guildId"|"channelId"|"trigger">>): Promise<Cooldown[]>
ParamTypeRequired
user
user
UserResolvable
UserResolvable
Yes
options
options
Partial<Pick<Cooldown.Data, "guildId"|"channelId"|"trigger">>
Partial<Pick<Cooldown.Data, "guildId"|"channelId"|"trigger">>
No

Returns:

Promise<Cooldown[]>
Promise<Cooldown[]>

fetchForChannel(channel: ChannelResolvable, options?: Partial<Pick<Cooldown.Data, "guildId"|"userId"|"trigger">>): Promise<Cooldown[]>
fetchForChannel(channel: ChannelResolvable, options?: Partial<Pick<Cooldown.Data, "guildId"|"userId"|"trigger">>): Promise<Cooldown[]>
ParamTypeRequired
channel
channel
ChannelResolvable
ChannelResolvable
Yes
options
options
Partial<Pick<Cooldown.Data, "guildId"|"userId"|"trigger">>
Partial<Pick<Cooldown.Data, "guildId"|"userId"|"trigger">>
No

Returns:

Promise<Cooldown[]>
Promise<Cooldown[]>

fetchForGuild(guild: GuildResolvable, options?: Partial<Pick<Cooldown.Data, "userId"|"channelId"|"trigger">>): Promise<Cooldown[]>
fetchForGuild(guild: GuildResolvable, options?: Partial<Pick<Cooldown.Data, "userId"|"channelId"|"trigger">>): Promise<Cooldown[]>
ParamTypeRequired
guild
guild
GuildResolvable
GuildResolvable
Yes
options
options
Partial<Pick<Cooldown.Data, "userId"|"channelId"|"trigger">>
Partial<Pick<Cooldown.Data, "userId"|"channelId"|"trigger">>
No

Returns:

Promise<Cooldown[]>
Promise<Cooldown[]>

create(data: Omit<Cooldown.Data, "id">|JSONEncodable<Omit<Cooldown.Data, "id">>): Promise<Cooldown>
create(data: Omit<Cooldown.Data, "id">|JSONEncodable<Omit<Cooldown.Data, "id">>): Promise<Cooldown>
ParamTypeRequired
data
data
Omit<Cooldown.Data, "id">|JSONEncodable<Omit<Cooldown.Data, "id">>
Omit<Cooldown.Data, "id">|JSONEncodable<Omit<Cooldown.Data, "id">>
Yes

Returns:

Promise<Cooldown>
Promise<Cooldown>

createSweeper(interval?: number): NodeJS.Timeout
createSweeper(interval?: number): NodeJS.Timeout
ParamTypeRequired
interval
interval
number
number
No

Returns:

NodeJS.Timeout
NodeJS.Timeout

sweep(fetchAll?: boolean): Promise<Cooldown[]>
sweep(fetchAll?: boolean): Promise<Cooldown[]>
ParamTypeRequired
fetchAll
fetchAll
boolean
boolean
No

Returns:

Promise<Cooldown[]>
Promise<Cooldown[]>

CooldownManager.Options|undefined
CooldownManager.Options|undefined
Cooldown
Cooldown
Collection<string, Cooldown>
Collection<string, Cooldown>