twitch-core/dist/users/TwitchChatUser.d.ts

Twitch bot command client

import { Badges, CommonUserstate } from 'tmi.js';
import { TwitchCommandClient, ChatterState } from '../client/TwitchCommandClient';
declare class TwitchChatUser {
    private originalMessage;
    private client;
    constructor(originalMessage: ChatterState, client: TwitchCommandClient);
    /**
     * Get display-name
     */
    get displayName(): string;
    /**
     * Get username
     */
    get username(): string;
    /**
     * Get badges
     */
    get badges(): Badges;
    /**
     * Get user-id
     */
    get id(): string;
    /**
     * Get user-type on string
     */
    get userType(): CommonUserstate['userType'];
    /**
     * Whisper a message to the user
     * @param message
     */
    whisper(message: string): Promise<[string, string]>;
    /**
     * Get the user #channel
     */
    get channel(): string;
    /**
     * Check if user is Turbo
     */
    get isTurbo(): boolean;
    /**
     * Check if user is the channel vip
     */
    get isVip(): boolean;
    /**
     * Check if user is the channel broadcaster
     */
    get isBroadcaster(): boolean;
    /**
     * Check if user is the channel subscriber
     */
    get isSubscriber(): boolean;
    /**
     * Check if user is the channel moderator
     */
    get isModerator(): boolean;
}
export { TwitchChatUser };