ShelfAuthInstance
Defined in: packages/auth/src/engine.ts:211
Subset of the Better Auth instance surface the shelf uses.
Properties
Section titled “Properties”api:
object
Defined in: packages/auth/src/engine.ts:214
getSession()
Section titled “getSession()”getSession(
input):Promise<{user:EngineSessionUser; } |null>
Resolve the session user from request headers (null when anonymous).
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”Promise<{ user: EngineSessionUser; } | null>
signOut()
Section titled “signOut()”signOut(
input):Promise<unknown>
Revoke the session carried by the headers.
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”Promise<unknown>
handler
Section titled “handler”handler: (
request) =>Response|Promise<Response>
Defined in: packages/auth/src/engine.ts:213
HTTP handler (mount at /api/auth/*).
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Response | Promise<Response>