client
signIn()β
signIn<
P
>(providerId
?,options
?,authorizationParams
?):Promise
<Response
>
Client-side method to initiate a signin flow or send the user to the signin page listing all possible providers. Automatically adds the CSRF token to the request.
import { signIn } from "@auth/astro/client"
signIn()
signIn("provider") // example: signIn("github")
Type parametersβ
βͺ P extends RedirectableProviderType
= undefined
Parametersβ
βͺ providerId?: LiteralUnion
< P
extends RedirectableProviderType
? P
| BuiltInProviderType
: BuiltInProviderType
, string
>
βͺ options?: SignInOptions
βͺ authorizationParams?: SignInAuthorizationParams
Returnsβ
Promise
< Response
>
signOut()β
signOut(
options
?):Promise
<void
>
Signs the user out, by removing the session cookie. Automatically adds the CSRF token to the request.
import { signOut } from "@auth/astro/client"
signOut()
Parametersβ
βͺ options?: SignOutParams
< true
>
Returnsβ
Promise
< void
>
SignInAuthorizationParamsβ
SignInAuthorizationParams:
string
|string
[][] |Record
<string
,string
> |URLSearchParams
Match inputType
of new URLSearchParams(inputType)