Suggestion: Refactor Function Signatures to Accept Object Parameters

[GabuTheDev]

Description

Currently, many functions accept multiple parameters, which can lead to verbose function calls and potential issues with parameter order. To improve the flexibility and readability of the code, consider refactoring these funtions to accept object parameters instead.

Here are some benefits of upgrading:

• Flexibility: Object parameters allow us to pass only the necessary values and easily extend the parameter list in the future without modifying function signatures or affecting calling code.
• Readability: Passing an object with named properties enhances code readability, especially when dealing with functions that have multiple parameters.

Examples:

A pretty good example is the auth function.

import { auth } from "osu-api-extended";

// before
await auth.login(client_id, client_secret); 

// after
await auth.login(method, {
    client_id: 0,
    client_secret: 0,
    scopes: []
}); 

with this kind of upgrade, you can also opt-in for a single auth function.

You can now merge auth.login(), auth.login_lazer() & auth.authorize_cli() into 1 function:

const method = "lazer"; // could be either "stable", "lazer" or "cli"
data = {
    client_id: 0,
    client_secret: 0,

    login: 0,
    password: 0,

    callbackUrl: 0,
    scopes: [ 0, 0, 0 ]
};

meaning:

• for method="stable" you would need client_id , client_secret & scopes.
• for method="lazer" you would need username & password.
• for method="cli" you would need client_id, client_secret, callback_url & scopes

or you could give up on the method property entirely. here"s a code example:

async login(method, data) => {
    if (method === "stable") {
        // perform "stable" auth...
    } else if (method === "lazer") {
        // perform "lazer" auth...
    } else if (method === "cli") {
        // perform "cli" auth...
    } else thow new Error("something went wrong");
}

[GabuTheDev]

I am sorry if this does not fit your codebase, I wanted to give it a try and code this but I found myself lost in the files.

[yorunoken]

seems easy enough to implement?

type parametersType = { clientId?: number, clientSecret?: string, redirectUri?: string, scope?: auth_scopes, state?: string, username?: string, password?: string }
type methodType = "lazer" | "stable" | "cli"

export async function login(method: methodType, { clientId, clientSecret, redirectUri, scope, state, username, password }: parametersType){
  switch(method){
    case "lazer":
      return (await login_lazer(username, password))
    case "stable":
      return (await login_stable(clientId, clientSecret, scope))
    case "cli":
      return (await authorize_cli(clientId, clientSecret, redirectUri, scope, state))
    default:
      throw new Error("blah b lah...")
  }
}

[yorunoken]

will PR when I catch a break. Writing this from my work computer XD Also would be useful to add in checks to make sure parameters are filled appropriately

[cyperdark]

like that ? https://github.com/cyperdark/osu-api-extended/commit/4be0e033b7d5454cd779e6ad4f99c1cc96da9930

[GabuTheDev]

like that ? https://github.com/cyperdark/osu-api-extended/commit/4be0e033b7d5454cd779e6ad4f99c1cc96da9930

My initial proposal was to have the method value detached from the passing object, as a different parameter.

[cyperdark]

It's done like that to have autocomplition like this

https://github.com/cyperdark/osu-api-extended/assets/21735205/351c9232-3e3d-42dd-9d70-32321dd23d13

[yorunoken]

you can technically still have that without including it in the object. Most IDEs allow you to simply click ctrl+space to let you autocomplete

[GabuTheDev]

yeah but:

[yorunoken]

yea, that's what I was saying. btw your gif doesn't work

[GabuTheDev]

yea, that's what I was saying. btw your gif doesn't work

it doesn't load? lemme upload it again:

[yorunoken]

works now yea

[cyperdark]

@GabuTheDev look at video again, after i specify a method autocomplition will show parameters that can be specified for this method, rest will be hidden

[GabuTheDev]

@GabuTheDev look at video again, after i specify a method autocomplition will show parameters that can be specified for this method, rest will be hidden

Whatever, just push this pr.