Skip to content

v1.1.0

Latest
Latest
Compare
Choose a tag to compare
@TTTaevas TTTaevas released this 29 Oct 15:16
· 1 commit to master since this release
v1.1.0
73c475f

Big new release for osu-api-v2-js! It comes with breaking changes, so please keep on reading to see what has changed and how that will affect you!

The more important changes

  • Node 16 is no longer supported, Node 18 is now the oldest supported version
  • API.createAsync() now doesn't want your client details in an object, it wants the id and secret separately
  • API.createAsync() now allows you to specify settings other than verbose, timeout or server, but regardless of what you specify, it wants them all in an object
  • The API's retry accessor has been split into multiple accessors; make retry_maximum_amount 0 if you had retry.disabled on true
  • Similarly, the API's client and routes were also split
  • As a consequence of dropping node-fetch for the built-in implementation of fetch, what's expected from you when using API.withSettings() may be a little different

The still somewhat important changes

  • As is tradition with this package, Beatmapset.Event has been adjusted in hopes of avoiding bad surprises
  • As a consequence of the package now using the x-api-version header in most of its requests, anything that relates to Scores has seen at least some kind of change, I'm pretty sure almost everything uses the more modern format now (the so-called "solo_score")
  • As another consequence, API.getFriends() now returns an object with the relation with the User, with the unchanged User in the object (as target)
  • The previously-deprecated cover_url of User is now gone
  • API.revokeToken() now doesn't return true for literally no reason anymore (now typed to void)

The changes that are kinda whatever

  • License change, switched from WTFPL to Unlicense, they're basically the same thing so that shouldn't affect you, lemme know if it does though
  • API.lookupUsers() now exists
  • The code is now compiled to a modern version of ECMAScript, please check out the history of the tsconfig.json file for more details on that change, this change shouldn't affect you but absolutely let me know if that change screws with anything on your side

Please, as always, feel free to contact me or to open up an issue if you encounter anything that's bothering you or that you find too complicated, I am here to help!
Thank you very much for using osu-api-v2-js! <3

Full Changelog: v1.0.5...v1.1.0

Assets 2
Loading