youtubei
Version:
Simple package to get information from youtube such as videos, playlists, channels, video information & comments, related videos, up next video, and more!
45 lines (44 loc) • 1.76 kB
TypeScript
import { HTTP, HTTPOptions, Shelf } from "../../common";
import { MusicAlbumCompact } from "../MusicAlbumCompact";
import { MusicArtistCompact } from "../MusicArtistCompact";
import { MusicLyrics } from "../MusicLyrics";
import { MusicPlaylistCompact } from "../MusicPlaylistCompact";
import { MusicSearchResult, MusicSearchType } from "../MusicSearchResult";
import { MusicVideoCompact } from "../MusicVideoCompact";
export declare type MusicTopShelf = {
item?: MusicVideoCompact | MusicAlbumCompact | MusicPlaylistCompact | MusicArtistCompact;
more?: (MusicVideoCompact | MusicAlbumCompact | MusicPlaylistCompact | MusicArtistCompact)[];
};
export declare type MusicClientOptions = HTTPOptions;
/** Youtube Music Client */
export declare class MusicClient {
/** @hidden */
http: HTTP;
constructor(options?: Partial<MusicClientOptions>);
/**
* Searches for video, song, album, playlist, or artist
*
* @param query The search query
* @param type Search type
*
*/
search(query: string): Promise<Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[] | MusicArtistCompact[]>[]>;
search<T extends MusicSearchType>(query: string, type: T): Promise<MusicSearchResult<T>>;
/**
* Searches for all video, song, album, playlist, or artist
*
* @param query The search query
*/
searchAll(query: string): Promise<{
top?: MusicTopShelf;
shelves: Shelf<MusicVideoCompact[] | MusicAlbumCompact[] | MusicPlaylistCompact[] | MusicArtistCompact[]>[];
}>;
/**
* Get lyrics of a song
*
* @param query The search query
* @param options Search options
*
*/
getLyrics(id: string): Promise<MusicLyrics | undefined>;
}