@twitchfy/chatbot
Version:
A powerful node module to make your own Twitch ChatBot
50 lines (49 loc) • 1.4 kB
TypeScript
import type { GetStream } from '@twitchfy/api-types';
import type { ChatBot } from './ChatBot';
import { BaseStream } from './BaseStream';
import type { EventSubConnection } from '../enums';
import type { Game, ThumbailOptions } from '../interfaces';
/**
* Represents a Twitch stream.
*/
export declare class Stream<T extends EventSubConnection> extends BaseStream<T> {
/**
* The amount of viewers watching the stream.
*/
readonly viewerCount: number;
/**
* The language of the stream.
*/
readonly language: string;
/**
* The tags of the stream.
*/
readonly tags: string[];
/**
* Whether the stream is marked as mature.
*/
readonly isMature: boolean;
/**
* The game which is currently being played on the stream.
*/
readonly game: Game;
/**
* The data of the stream returned from the API.
*/
private data;
/**
* Creates a new instance of the stream.
* @param chatbot The current instance of the chatbot.
* @param data The data of the stream returned from the API.
*/
constructor(chatbot: ChatBot<T>, data: GetStream);
/**
* The title of the stream.
*/
get title(): string | null;
/**
* The thumbnail URL of the stream.
* @param options The options for the thumbnail.
*/
thumbnailURL(options?: ThumbailOptions): string;
}