Interface Config

An interface to tell the API what kind of scores should be in an array returned by a function

Please note that some properties will be ignored by certain functions, check this in case of doubt: https://osu.ppy.sh/docs/index.html#beatmaps

interface Config {
    legacy_only?: boolean;
    mods?: string[];
    ruleset?: Ruleset;
    type?: string;
}

Properties

legacy_only?: boolean

Exclude lazer scores? (defaults to false)

mods?: string[]

The Mods used to make the score, you can simply use ["NM"] to filter out scores with mods (defaults to any mods, no scores filtered)

ruleset?: Ruleset

The Ruleset used to make the score, useful if it was made on a convert

type?: string

"Beatmap score ranking type", whatever that means...