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

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

export interface response {
    beatmapsets: {
        artist: string;
        artist_unicode: string;
        covers: {
            cover: string;
            'cover@2x': string;
            card: string;
            'card@2x': string;
            list: string;
            'list@2x': string;
            slimcover: string;
            'slimcover@2x': string;
        };
        creator: string;
        favourite_count: number;
        hype?: string;
        id: number;
        nsfw: boolean;
        offset: number;
        play_count: number;
        preview_url: string;
        source: string;
        spotlight: boolean;
        status: string;
        title: string;
        title_unicode: string;
        track_id?: number;
        user_id: number;
        video: boolean;
        bpm: number;
        can_be_hyped: boolean;
        deleted_at?: string;
        discussion_enabled: boolean;
        discussion_locked: boolean;
        is_scoreable: boolean;
        last_updated: string;
        legacy_thread_url: string;
        nominations_summary: {
            current: number;
            required: number;
        };
        ranked: number;
        ranked_date: string;
        storyboard: boolean;
        submitted_date: string;
        tags: string;
        availability: {
            download_disabled: boolean;
            more_information: string;
        };
        has_favourited: boolean;
        beatmaps: {
            beatmapset_id: number;
            difficulty_rating: number;
            id: number;
            mode: string;
            status: string;
            total_length: number;
            user_id: number;
            version: string;
            accuracy: number;
            ar: number;
            bpm: number;
            convert: boolean;
            count_circles: number;
            count_sliders: number;
            count_spinners: number;
            cs: number;
            deleted_at?: string;
            drain: number;
            hit_length: number;
            is_scoreable: boolean;
            last_updated: string;
            mode_int: number;
            passcount: number;
            playcount: number;
            ranked: number;
            url: string;
            checksum: string;
            max_combo: number;
        }[];
        pack_tags: string[];
    }[];
    search: {
        sort: string;
    };
    recommended_difficulty: number;
    error: string;
    total: number;
    cursor: {
        approved_date: number;
        id: number;
    };
    cursor_string: string;
}
export interface types {
    /**
     * Return list of beatmaps
     *
     * ## Example
     *
     * ```js
     * const { v2, auth } = require('osu-api-extended');
     *
     * const main = async () => {
     *   await auth.login(CLIENT_ID, CLIENT_SECRET);
     *
     *   const v2_beatmaps_search = await v2.beatmaps.search(object);
     *   console.log(v2_beatmaps_search);
     * };
     *
     * main();
     * ```
     * @param {string} object.query search query, song ``title`` / ``artist``, ``stars``, ``bpm``, ``date`` and etc.
     * @param {string} object.sort ```title_desc``` or ```title_asc``` or ```artist_desc``` or ```artist_asc``` or ```difficulty_desc``` or ```difficulty_asc``` or ```updated_desc``` or ```updated_asc``` or ```ranked_desc``` or ```ranked_asc``` or ```rating_desc``` or ```rating_asc``` or ```plays_desc``` or ```plays_asc``` or ```favourites_desc``` or ```favourites_asc```
     * @param {string[]} object.general ```converts``` or ```follows``` or ```recommended``` or ````featured_artists```` or ````spotlights````
     * @param {string} object.mode ```osu``` or ```fruits``` or ```mania``` or ```taiko```
     * @param {string} object.section ```ranked``` or ```qualified``` or ```loved``` or ```favourites``` or ```pending``` or ```wip``` or ```graveyard``` or ```mine```
     * @param {string} object.genre ```Unspecified``` or ```Video Game``` or ```Anime``` or ```Rock``` or ```Pop``` or ```Other``` or ```Novelty``` or ```Hip Hop``` or ```Electronic``` or ```Metal``` or ```Classical``` or ```Folk``` or ```Jazz```
     * @param {string} object.language ```English``` or ```Chinese``` or ```French``` or ```German``` or ```Italian``` or ```Japanese``` or ```Korean``` or ```Spanish``` or ```Swedish``` or ```Russian``` or ```Polish``` or ```Instrumental``` or ```Unspecified``` or ```Other```
     * @param {string} object.include ```video``` or ```storyboard```
     * @param {string[]} object.rank ```XH``` or ```X``` or ```SH``` or ```S``` or ```A``` or ```B``` or ```C``` or ```D```
     * @param {boolean} object.nfsw ```true``` or ```false```
     * @param {string} object.played ```played``` or ```unplayed```
     * @param {string} object.cursor_string Pagination cursor
    */
    (object: {
        query?: string;
        sort?: 'title_desc' | 'title_asc' | 'artist_desc' | 'artist_asc' | 'difficulty_desc' | 'difficulty_asc' | 'updated_desc' | 'updated_asc' | 'ranked_desc' | 'ranked_asc' | 'rating_desc' | 'rating_asc' | 'plays_desc' | 'plays_asc' | 'favourites_desc' | 'favourites_asc';
        general?: Array<'converts' | 'follows' | 'recommended' | 'featured_artists' | 'spotlights'>;
        mode?: 'osu' | 'fruits' | 'mania' | 'taiko';
        section?: 'ranked' | 'qualified' | 'loved' | 'favourites' | 'pending' | 'wip' | 'graveyard' | 'mine';
        genre?: 'Unspecified' | 'Video Game' | 'Anime' | 'Rock' | 'Pop' | 'Other' | 'Novelty' | 'Hip Hop' | 'Electronic' | 'Metal' | 'Classical' | 'Folk' | 'Jazz';
        language?: 'English' | 'Chinese' | 'French' | 'German' | 'Italian' | 'Japanese' | 'Korean' | 'Spanish' | 'Swedish' | 'Russian' | 'Polish' | 'Instrumental' | 'Unspecified' | 'Other';
        include?: 'video' | 'storyboard';
        rank?: Array<'XH' | 'X' | 'SH' | 'S' | 'A' | 'B' | 'C' | 'D'>;
        nfsw?: 'true' | 'false';
        played?: 'played' | 'unplayed';
        cursor_string?: string;
    }): Promise<response[]>;
}