osu-api-v2-js
    Preparing search index...

    Interface Config

    Some endpoints allow you to customize the amount and order of what you will receive, such endpoints usually have a config argument that will expect an object that roughly meets this very interface!

    interface Config {
        cursor_string?: string;
        limit?: number;
        page?: number;
        sort?: Sort;
    }
    Index

    Properties

    cursor_string? limit? page? sort?

    Properties

    cursor_string?: string

    A cursor_string provided by a previous request

    limit?: number

    The maximum amount of results to get

    Regardless of the limit, the API server will not send more than a certain amount of results, that amount being different for every endpoint

    Optionalpage

    page?: number

    Which page of the results to get

    sort?: Sort

    "id_asc" to have the oldest element first, "id_desc" to have the newest instead

    Settings

    Member Visibility

    On This Page

    Properties