client
Functions
signIn()
Signature
signIn<P>(providerId?: LiteralUnion<P extends RedirectableProviderType ? BuiltInProviderType | P : BuiltInProviderType, string>, options?: SignInOptions, authorizationParams?: SignInAuthorizationParams): 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.
Type parameters
Pextendsundefined|RedirectableProviderType=undefined
Parameters
| Name | Type |
|---|---|
providerId? | LiteralUnion<P extends RedirectableProviderType ? BuiltInProviderType | P : BuiltInProviderType, string> |
options? | SignInOptions |
authorizationParams? | SignInAuthorizationParams |
Returns
Promise<undefined | Response>
signOut()
Signature
signOut(options?: SignOutParams<true>): Promise<void>
Signs the user out, by removing the session cookie. Automatically adds the CSRF token to the request.
Parameters
| Name | Type |
|---|---|
options? | SignOutParams<true> |
Returns
Promise<void>