recipe/session | supertokens-node

Index

References

SessionRequest

Type aliases

APIOptions

APIOptions: { config: TypeNormalisedInput; isInServerlessEnv: boolean; recipeId: string; recipeImplementation: RecipeInterface; req: BaseRequest; res: BaseResponse }

Type declaration

config: TypeNormalisedInput
isInServerlessEnv: boolean
recipeId: string
recipeImplementation: RecipeInterface
req: BaseRequest
res: BaseResponse

SessionInformation

SessionInformation: { expiry: number; jwtPayload: any; sessionData: any; sessionHandle: string; timeCreated: number; userId: string }

Type declaration

expiry: number
jwtPayload: any
sessionData: any
sessionHandle: string
timeCreated: number
userId: string

Variables

Error

Error: typeof default = ...

Functions

createNewSession

createNewSession(res: any, userId: string, jwtPayload?: any, sessionData?: any): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:96
Parameters
- res: any
- userId: string
- jwtPayload: any = {}
- sessionData: any = {}
Returns Promise<SessionContainer>

getAllSessionHandlesForUser

getAllSessionHandlesForUser(userId: string): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:106
Parameters
- userId: string
Returns Promise<string[]>

getJWTPayload

getJWTPayload(sessionHandle: string): Promise<any>

- Defined in lib/ts/recipe/session/index.ts:118
deprecated
Use getSessionInformation instead IF using core version >= 3.5

Parameters
- sessionHandle: string
Returns Promise<any>

getSession

getSession(req: any, res: any, options?: VerifySessionOptions): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:98
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions
Returns Promise<undefined | SessionContainer>

getSessionData

getSessionData(sessionHandle: string): Promise<any>

- Defined in lib/ts/recipe/session/index.ts:113
deprecated
Use getSessionInformation instead IF using core version >= 3.5

Parameters
- sessionHandle: string
Returns Promise<any>

getSessionInformation

getSessionInformation(sessionHandle: string): Promise<SessionInformation>

- Defined in lib/ts/recipe/session/index.ts:100
Parameters
- sessionHandle: string
Returns Promise<SessionInformation>

init

init(config?: TypeInput): RecipeListFunction

- Defined in lib/ts/recipe/session/index.ts:94
Parameters
- Optional config: TypeInput
Returns RecipeListFunction

refreshSession

refreshSession(req: any, res: any): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:102
Parameters
- req: any
- res: any
Returns Promise<SessionContainer>

revokeAllSessionsForUser

revokeAllSessionsForUser(userId: string): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:104
Parameters
- userId: string
Returns Promise<string[]>

revokeMultipleSessions

revokeMultipleSessions(sessionHandles: string[]): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:110
Parameters
- sessionHandles: string[]
Returns Promise<string[]>

revokeSession

revokeSession(sessionHandle: string): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:108
Parameters
- sessionHandle: string
Returns Promise<boolean>

updateJWTPayload

updateJWTPayload(sessionHandle: string, newJWTPayload: any): Promise<void>

- Defined in lib/ts/recipe/session/index.ts:120
Parameters
- sessionHandle: string
- newJWTPayload: any
Returns Promise<void>

updateSessionData

updateSessionData(sessionHandle: string, newSessionData: any): Promise<void>

- Defined in lib/ts/recipe/session/index.ts:115
Parameters
- sessionHandle: string
- newSessionData: any
Returns Promise<void>

verifySession

verifySession(options?: VerifySessionOptions): (req: SessionRequest, res: Response, next: NextFunction) => Promise<void>

- Defined in lib/ts/recipe/session/index.ts:125
deprecated
Parameters
- Optional options: VerifySessionOptions
Returns (req: SessionRequest, res: Response, next: NextFunction) => Promise<void>
- - (req: SessionRequest, res: Response, next: NextFunction): Promise<void>
  - Parameters
    - req: SessionRequest
    - res: Response
    - next: NextFunction
    Returns Promise<void>

Index

References

Classes

Interfaces

Type aliases

Variables

Functions

References

SessionRequest

Type aliases

APIOptions

Type declaration

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

SessionInformation

Type declaration

expiry: number

jwtPayload: any

sessionData: any

sessionHandle: string

timeCreated: number

userId: string

Variables

Error

Functions

createNewSession

Parameters

res: any

userId: string

jwtPayload: any = {}

sessionData: any = {}

Returns Promise<SessionContainer>

getAllSessionHandlesForUser

Parameters

userId: string

Returns Promise<string[]>

getJWTPayload

Parameters

sessionHandle: string

Returns Promise<any>

getSession

Parameters

req: any

res: any

Optional options: VerifySessionOptions

Returns Promise<undefined | SessionContainer>

getSessionData

Parameters

sessionHandle: string

Returns Promise<any>

getSessionInformation

Parameters

sessionHandle: string

Returns Promise<SessionInformation>

init

Parameters

Optional config: TypeInput

Returns RecipeListFunction

refreshSession

Parameters

req: any

res: any

Returns Promise<SessionContainer>

revokeAllSessionsForUser

Parameters

userId: string

Returns Promise<string[]>

revokeMultipleSessions

Parameters

sessionHandles: string[]

Returns Promise<string[]>

revokeSession

Parameters

sessionHandle: string

Returns Promise<boolean>

updateJWTPayload