client

SignInOptions

Extends

• Record<string, unknown>

Properties

callbackUrl?

optional callbackUrl: string;

Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.

Documentation

redirect?

optional redirect: boolean;

Documentation

SignOutParams<R>

Type parameters

Properties

callbackUrl?

optional callbackUrl: string;

Documentation

redirect?

optional redirect: R;

[Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option-1

LiteralUnion<T, U>

type LiteralUnion<T, U>: T | U & Record<never, never>;

Type parameters

SignInAuthorizationParams

type SignInAuthorizationParams: string | string[][] | Record<string, string> | URLSearchParams;

Match inputType of new URLSearchParams(inputType)

signIn()

signIn<P>(
   providerId?, 
   options?, 
authorizationParams?): Promise<undefined | 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

Parameters

Returns

Promise<undefined | 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

Returns

Promise<void>