src/services/CooldownService.ts

/**
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { Snowflake } from "discord.js";
import Service from "../core/Service";

export const name = "cooldown";

export default class CooldownService extends Service {
    protected readonly underCooldown: Record<`${Snowflake}_${string}`, number | undefined> = {};

    has(guildId: Snowflake, commandName: string) {
        return !!this.underCooldown[`${guildId}_${commandName}`];
    }

    /**
     * Locks a cooldown entry.
     *
     * @param guildId
     * @param commandName
     * @param cooldownValue The cooldown time interval in milliseconds
     */
    lock(guildId: Snowflake, commandName: string, cooldownValue: number) {
        if (this.has(guildId, commandName)) {
            return { enabled: true, cooldown: this.underCooldown[`${guildId}_${commandName}`] };
        }

        this.underCooldown[`${guildId}_${commandName}`] = Date.now() + cooldownValue;
        setTimeout(() => (this.underCooldown[`${guildId}_${commandName}`] = undefined), cooldownValue);
        return { enabled: false, cooldown: this.underCooldown[`${guildId}_${commandName}`] };
    }
}
1	/**
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2023 OSN Developers.
5	*
6	* SudoBot is free software; you can redistribute it and/or modify it
7	* under the terms of the GNU Affero General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* SudoBot is distributed in the hope that it will be useful, but
12	* WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU Affero General Public License for more details.
15	*
16	* You should have received a copy of the GNU Affero General Public License
17	* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18	*/
19
20	import { Snowflake } from "discord.js";
21	import Service from "../core/Service";
22
23	export const name = "cooldown";
24
25	export default class CooldownService extends Service {
26	protected readonly underCooldown: Record<`${Snowflake}_${string}`, number \| undefined> = {};
27
28	has(guildId: Snowflake, commandName: string) {
29	return !!this.underCooldown[`${guildId}_${commandName}`];
30	}
31
32	/**
33	* Locks a cooldown entry.
34	*
35	* @param guildId
36	* @param commandName
37	* @param cooldownValue The cooldown time interval in milliseconds
38	*/
39	lock(guildId: Snowflake, commandName: string, cooldownValue: number) {
40	if (this.has(guildId, commandName)) {
41	return { enabled: true, cooldown: this.underCooldown[`${guildId}_${commandName}`] };
42	}
43
44	this.underCooldown[`${guildId}_${commandName}`] = Date.now() + cooldownValue;
45	setTimeout(() => (this.underCooldown[`${guildId}_${commandName}`] = undefined), cooldownValue);
46	return { enabled: false, cooldown: this.underCooldown[`${guildId}_${commandName}`] };
47	}
48	}