osu-api-extended/dist/types/v2_beatmap_set_download.d.ts

Advanced osu! api wrapper for v1 and v2, with extra stuff

export interface response {
}
export interface types {
    /**
     * Download beatmap set to specified directory
     *
     * ## Example
     *
     * ```js
     * const { v2, auth } = require('osu-api-extended');
     *
     * const main = async () => {
     *   await auth.login_lazer(USERNAME, USER_PASSWORD);
     *
     *   const v2_beatmap_set_download = await v2.beatmap.set.download(beatmapset, file_path, host_name, no_video, callback);
     *   console.log(v2_beatmap_set_download);
     * };
     *
     * main();
     * ```
     * @param {number} beatmapset id of the beatmap set
     * @param {string} file_path path to file with their name and extension
     * @param {string} host_name ```osu``` or ```chimu``` or ```beatconnect``` or ```sayobot``` or ```nerinyan``` or
     * @param {boolean} no_video Download with or without video
     * @param {Function} callback function which is will be triggered on downloading progress
    */
    (beatmapset: number, file_path: string, host_name: 'osu' | 'chimu' | 'beatconnect' | 'sayobot' | 'nerinyan' | 'mino' | '', no_video: boolean, callback?: Function): Promise<string | {
        error: string;
    }>;
}