Skip to main content

client

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.

Documentation

Type parameters​

▪ P extends undefined | RedirectableProviderType = undefined

Parameters​

▪ providerId?: LiteralUnion< P extends RedirectableProviderType ? P | BuiltInProviderType : BuiltInProviderType, string >

▪ options?: SignInOptions

▪ authorizationParams?: SignInAuthorizationParams

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.

Documentation

Parameters​

▪ options?: SignOutParams< true >

Returns​

Promise< void >

SignInAuthorizationParams​

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

Match inputType of new URLSearchParams(inputType)