aboutsummaryrefslogtreecommitdiff
path: root/node_modules/genius-lyrics/dist/Songs/Client.d.ts
blob: cc8c499020599522bea75167a70399d3307a5b64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import { Client } from "../";
import { Song } from "./Song";
export interface SongSearchOptions {
    sanitizeQuery: boolean;
}
export declare class SongsClient {
    readonly client: Client;
    /**
     * @example const SongsClient = new Genius.Songs.Client(key);
     */
    constructor(client: Client);
    /**
     * Searches for songs for the provided query (Key is optional)
     * @example const SearchResults = await SongsClient.search("faded");
     */
    search(query: string, options?: Partial<SongSearchOptions>): Promise<Song[]>;
    /**
     * Fetches the Song using the provided ID (Requires Key)
     * @example const Song = await SongsClient.get(3276244);
     */
    get(id: number): Promise<Song>;
    sanitizeQuery(query: string): string;
}