@twitchfy/chatbot
Version:
A powerful node module to make your own Twitch ChatBot
28 lines (27 loc) • 940 B
TypeScript
import { Base } from '../Base';
import type { ChatBot } from '../ChatBot';
import { Warning } from '../Warning';
import type { ChatRoom } from '../ChatRoom';
import type { EventSubConnection } from '../../enums';
/**
* The warns manager of a chatroom.
*/
export declare class WarnsManager<T extends EventSubConnection> extends Base<T> {
/**
* The chatroom instance.
*/
readonly chatroom: ChatRoom<T>;
/**
* Creates a new instance of the warns manager.
* @param chatbot The current instance of the chatbot.
* @param chatroom The chatroom instance.
*/
constructor(chatbot: ChatBot<T>, chatroom: ChatRoom<T>);
/**
* Creates warn for an user in a specific chatroom.
* @param chatroomId The id of the chatroom where the user will be warned.
* @param userId The id of the user to warn.
* @returns
*/
create(userId: string, reason: string): Promise<Warning<T>>;
}