Inconsistent return values of signIn() and signOut()

[danielsavinoff]

Goals

1. Be consistent

Non-Goals

No response

Background

This is what it says in the NextAuthResult interface signOut and signIn should return with the option redirect false.

signOut()

  signOut: <R extends boolean = true>(options?: {
    /** The relative path to redirect to after signing out. By default, the user is redirected to the current page. */
    redirectTo?: string
    **/** If set to `false`, the `signOut` method will return the URL to redirect to instead of redirecting automatically. */**
    redirect?: R
  }) => Promise<R extends false ? any : never>

signIn()

signIn: <
    P extends BuiltInProviderType | (string & {}),
    R extends boolean = true,
  >(
    /** Provider to sign in to */
    provider?: P, // See: https://github.com/microsoft/TypeScript/issues/29729
    options?:
      | FormData
      | ({
          /** The relative path to redirect to after signing in. By default, the user is redirected to the current page. */
          redirectTo?: string
          **/** If set to `false`, the `signIn` method will return the URL to redirect to instead of redirecting automatically. */
          redirect?: R**
        } & Record<string, any>),
    authorizationParams?:
      | string[][]
      | Record<string, string>
      | string
      | URLSearchParams
  ) => Promise<R extends false ? any : never>

In the actual implementation of the functions signIn() returns the URL as expected but signOut() returns a response. It is extremely confusing. And is there at least one logical reason both return types are any?

Proposal

Stop the mess, use typescript and type variables, and don't write confusing comments.