@twitchfy/chatbot/dist/structures/managers/BanManager.d.ts

A powerful node module to make your own Twitch ChatBot

import { Base } from '../Base';
import type { ChatRoom } from '../ChatRoom';
import type { ChatBot } from '../ChatBot';
import type { EventSubConnection } from '../../enums';
import type { BanOptions } from '../../interfaces';
/**
 * The ban manager of a chatroom.
 */
export declare class BanManager<T extends EventSubConnection> extends Base<T> {
    /**
     * The chatroom which includes this manager.
     */
    readonly chatroom: ChatRoom<T>;
    /**
     * Creates a new instance of the badge manager.
     * @param chatbot The current instance of the chatbot.
     * @param chatroom The chatroom which includes this manager.
     */
    constructor(chatbot: ChatBot<T>, chatroom: ChatRoom<T>);
    /**
     * Ban a specific user.
     * @param options The options required for banning an user. See {@link BanOptions}.
     * @returns A class representation of the ban. See {@link Ban}.
     */
    add(options: BanOptions): Promise<import("structures").Ban<T>>;
    /**
     * Deletes the ban of a specific user.
     * @param userId The id of the user to unban.
     * @returns
     */
    delete(userId: string): Promise<void>;
}