@miukyo/ytlc
    Preparing search index...

    Interface YTLiveChatOptions

    Configuration for YTLiveChat behavior.

    const chat = new YTLiveChat({
      requestFrequency: 1200,
      autoReconnect: true,
      reconnectMaxAttempts: 5,
      reconnectDelayMs: 2000,
    });
    interface YTLiveChatOptions {
        youtubeBaseUrl?: string;
        requestFrequency?: number;
        enableContinuousLivestreamMonitor?: boolean;
        liveCheckFrequency?: number;
        autoReconnect?: boolean;
        reconnectMaxAttempts?: number;
        reconnectDelayMs?: number;
        debugLogReceivedJsonItems?: boolean;
        debugLogFilePath?: string;
        fetchImplementation?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
    }
    Index

    Properties

    youtubeBaseUrl? requestFrequency? enableContinuousLivestreamMonitor? liveCheckFrequency? autoReconnect? reconnectMaxAttempts? reconnectDelayMs? debugLogReceivedJsonItems? debugLogFilePath? fetchImplementation?

    Properties

    youtubeBaseUrl?: string

    Base URL for YouTube endpoints.

    requestFrequency?: number

    Poll interval for fetching new chat actions (ms).

    enableContinuousLivestreamMonitor?: boolean

    If true and started with handle/channelId, keep checking for future live sessions.

    liveCheckFrequency?: number

    Poll interval used while waiting for channel to become live (ms).

    autoReconnect?: boolean

    Enable reconnect attempts when requests fail.

    reconnectMaxAttempts?: number

    Maximum reconnect attempts before chat stops.

    reconnectDelayMs?: number

    Fixed delay between reconnect attempts (ms).

    debugLogReceivedJsonItems?: boolean

    Append raw actions to a debug file.

    debugLogFilePath?: string

    Path used when debugLogReceivedJsonItems is enabled.

    fetchImplementation?: (
        input: string | URL | Request,
        init?: RequestInit,
    ) => Promise<Response>

    Custom fetch implementation for testing or non-standard runtimes.

    Settings

    Member Visibility

    On This Page

    Properties