Skip to main content

Module: client

Functions​

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​

NameType
Pextends undefined | RedirectableProviderType = undefined

Parameters​

NameType
providerId?LiteralUnion<P extends RedirectableProviderType ? BuiltInProviderType | P : 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​

NameType
options?SignOutParams<true>

Returns​

Promise<void>