xdl-node/dist/twspace.d.ts

A library for retrieving audio streams and other data from X Spaces, built on Node.js and TypeScript.

import { TwitterAPI } from './api';
export declare class Twspace {
    id: string;
    url: string;
    title: string;
    creator_name: string;
    creator_id: string;
    creator_screen_name: string;
    creator_profile_image_url: string;
    start_date: string;
    state: string;
    available_for_replay: string;
    media_key: string;
    source?: any;
    root?: any;
    /**
     * Конструктор принимает объект metadata, полученный от API.
     * @param metadata - объект с данными Space
     */
    constructor(metadata: any);
    /**
     * Функция для "санитаризации" имени файла.
     * @param value - исходное имя файла.
     * @returns Допустимое имя файла.
     */
    static sterilizeFn(value: string): string;
    /**
     * Формирует имя файла по заданному шаблону.
     * Пример шаблона: "(%(creator_name)s)%(title)s-%(id)s"
     * @param formatStr - шаблон имени файла.
     * @returns Полный путь к файлу.
     */
    format(formatStr: string): string;
    /**
     * Создаёт экземпляр Twspace по URL твиттер-спейса.
     * @param url - URL твиттер-спейса.
     * @param apiInstance - экземпляр TwitterAPI.
     * @returns Promise с экземпляром Twspace.
     */
    static fromSpaceUrl(url: string, apiInstance: TwitterAPI): Promise<Twspace>;
    /**
     * Создаёт экземпляр Twspace по URL пользователя (ищется текущий эфир).
     * @param user_url - URL пользователя.
     * @param apiInstance - экземпляр TwitterAPI.
     * @returns Promise с экземпляром Twspace.
     */
    static fromUserAvatar(user_url: string, apiInstance: TwitterAPI): Promise<Twspace>;
    /**
     * Создаёт экземпляр Twspace из файла с metadata.
     * @param filePath - путь к файлу.
     * @returns Экземпляр Twspace.
     */
    static fromFile(filePath: string): Twspace;
}