youtubei/dist/typings/music/MusicSearchResult/MusicSearchResult.d.ts

Simple package to get information from youtube such as videos, playlists, channels, video information & comments, related videos, up next video, and more!

import { MusicAlbumCompact } from "../MusicAlbumCompact";
import { MusicArtistCompact } from "../MusicArtistCompact";
import { FetchResult, MusicContinuable, MusicContinuableConstructorParams } from "../MusicContinuable";
import { MusicPlaylistCompact } from "../MusicPlaylistCompact";
import { MusicSongCompact } from "../MusicSongCompact";
import { MusicVideoCompact } from "../MusicVideoCompact";
export declare enum MusicSearchTypeEnum {
    Song = "song",
    Video = "video"
}
export declare type MusicSearchType = "song" | "video" | MusicSearchTypeEnum | undefined;
export declare type MusicSearchResultItem<T = undefined> = T extends "song" ? MusicSongCompact : T extends "video" ? MusicVideoCompact : MusicVideoCompact | MusicAlbumCompact | MusicPlaylistCompact | MusicArtistCompact;
declare type MusicLyricsProperties = MusicContinuableConstructorParams & {
    type?: MusicSearchType;
};
/**
 * Represents search result, usually returned from `client.search();`.
 *
 * {@link MusicSearchResult} is a helper class to manage search result
 *
 * @example
 * ```ts
 * const result = await music.search("Keyword", "song");
 *
 * console.log(result.items); // search result from first page
 *
 * let nextSearchResult = await result.next();
 * console.log(nextSearchResult); // search result from second page
 *
 * nextSearchResult = await result.next();
 * console.log(nextSearchResult); // search result from third page
 *
 * console.log(result.items); // search result from first, second, and third page.
 * ```
 *
 * @noInheritDoc
 */
export declare class MusicSearchResult<T extends MusicSearchType = undefined> extends MusicContinuable<MusicSearchResultItem<T>> {
    top: {
        item: MusicSearchResultItem;
        more: MusicSearchResultItem[];
    } | null;
    private type;
    /** @hidden */
    constructor({ client, type }: MusicLyricsProperties);
    /**
     * Initialize data from search
     *
     * @param query Search query
     * @param options Search Options
     *
     * @hidden
     */
    search(query: string, type?: MusicSearchType): Promise<MusicSearchResult<T>>;
    protected fetch(): Promise<FetchResult<MusicSearchResultItem<T>>>;
}
export {};