Class Osu

Hierarchy

Osu

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Osu(token: string): Osu

- Defined in index.ts:19
Parameters
- token: string
Returns Osu

Properties

Private Readonly baseUrl

baseUrl: "https://osu.ppy.sh/api" = "https://osu.ppy.sh/api"

Private token

token: null | string = null

Methods

Private _request

_request(path: string, opt: unknown): Promise<unknown>

- Defined in index.ts:114
Parameters
- path: string
- opt: unknown
Returns Promise<unknown>

getBeatmaps

getBeatmaps(opt: beatOpt): Promise<OsuBeat[]>

- Defined in index.ts:25
Parameters
- opt: beatOpt
Returns Promise<OsuBeat[]>

getBest

getBest(opt: recentAndBestOpt): Promise<OsuBest[]>

- Defined in index.ts:64
Parameters
- opt: recentAndBestOpt
Returns Promise<OsuBest[]>

getMatch

getMatch(opt: matchOpt): Promise<OsuMatch>

- Defined in index.ts:92
Parameters
- opt: matchOpt
Returns Promise<OsuMatch>

getRecent

getRecent(opt: recentAndBestOpt): Promise<OsuRecent[]>

- Defined in index.ts:78
Parameters
- opt: recentAndBestOpt
Returns Promise<OsuRecent[]>

getReplay

getReplay(opt: replayOpt): Promise<OsuReplay>

- Defined in index.ts:103
Parameters
- opt: replayOpt
Returns Promise<OsuReplay>

getScores

getScores(opt: scoreOpt): Promise<OsuScores[]>

- Defined in index.ts:52
Parameters
- opt: scoreOpt
Returns Promise<OsuScores[]>

getUser

getUser(opt: userOpt): Promise<OsuUser[]>

- Defined in index.ts:38
Parameters
- opt: userOpt
Returns Promise<OsuUser[]>

Generated using TypeDoc