Skip to main content

Function: signOut()

signOut(options)​

function signOut(options?): Promise<Response>

Calls the Auth.js sign-out route to remove the active session.

Parameters​

ParameterTypeDescription
options?ClientOptionsOverrides for base path, headers, or a custom fetch implementation.

Returns​

Promise<Response>

A Response emitted by the /signout endpoint.

Examples​

await signOut()
await signOut({ fetch: myEdgeSafeFetch })

signOut(params, proxy, redirect)​

function signOut(
   params?, 
   proxy?, 
redirect?): Promise<Response | object | object | object>

Parameters​

ParameterType
params?object
params.callbackUrl?string
params.csrfToken?string
proxy?ClientOptions
redirect?RedirectMode

Returns​

Promise<Response | object | object | object>