Search
Preparing search index...
The search index is not available
supertokens-node
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-node
recipe/session
default
Class default
Hierarchy
default
Index
Constructors
constructor
Properties
Error
init
Methods
create
New
Session
get
All
Session
Handles
For
User
get
Session
get
Session
Information
refresh
Session
revoke
All
Sessions
For
User
revoke
Multiple
Sessions
revoke
Session
update
Access
Token
Payload
update
Session
Data
Constructors
constructor
new default
(
)
:
default
Returns
default
Properties
Static
Error
Error
:
typeof
default
= ...
Static
init
init
:
(
config
?:
TypeInput
)
=>
RecipeListFunction
= ...
Type declaration
(
config
?:
TypeInput
)
:
RecipeListFunction
Parameters
Optional
config:
TypeInput
Returns
RecipeListFunction
Methods
Static
create
New
Session
create
New
Session
(
res
:
any
, userId
:
string
, accessTokenPayload
?:
any
, sessionData
?:
any
)
:
Promise
<
SessionContainer
>
Parameters
res:
any
userId:
string
accessTokenPayload:
any
= {}
sessionData:
any
= {}
Returns
Promise
<
SessionContainer
>
Static
get
All
Session
Handles
For
User
get
All
Session
Handles
For
User
(
userId
:
string
)
:
Promise
<
string
[]
>
Parameters
userId:
string
Returns
Promise
<
string
[]
>
Static
get
Session
get
Session
(
req
:
any
, res
:
any
, options
?:
VerifySessionOptions
)
:
Promise
<
undefined
|
SessionContainer
>
Parameters
req:
any
res:
any
Optional
options:
VerifySessionOptions
Returns
Promise
<
undefined
|
SessionContainer
>
Static
get
Session
Information
get
Session
Information
(
sessionHandle
:
string
)
:
Promise
<
SessionInformation
>
Parameters
sessionHandle:
string
Returns
Promise
<
SessionInformation
>
Static
refresh
Session
refresh
Session
(
req
:
any
, res
:
any
)
:
Promise
<
SessionContainer
>
Parameters
req:
any
res:
any
Returns
Promise
<
SessionContainer
>
Static
revoke
All
Sessions
For
User
revoke
All
Sessions
For
User
(
userId
:
string
)
:
Promise
<
string
[]
>
Parameters
userId:
string
Returns
Promise
<
string
[]
>
Static
revoke
Multiple
Sessions
revoke
Multiple
Sessions
(
sessionHandles
:
string
[]
)
:
Promise
<
string
[]
>
Parameters
sessionHandles:
string
[]
Returns
Promise
<
string
[]
>
Static
revoke
Session
revoke
Session
(
sessionHandle
:
string
)
:
Promise
<
boolean
>
Parameters
sessionHandle:
string
Returns
Promise
<
boolean
>
Static
update
Access
Token
Payload
update
Access
Token
Payload
(
sessionHandle
:
string
, newAccessTokenPayload
:
any
)
:
Promise
<
void
>
Parameters
sessionHandle:
string
newAccessTokenPayload:
any
Returns
Promise
<
void
>
Static
update
Session
Data
update
Session
Data
(
sessionHandle
:
string
, newSessionData
:
any
)
:
Promise
<
void
>
Parameters
sessionHandle:
string
newSessionData:
any
Returns
Promise
<
void
>
Modules
framework
framework/aws
Lambda
framework/express
framework/fastify
framework/hapi
framework/koa
framework/loopback
index
recipe/emailpassword
recipe/emailverification
recipe/jwt
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
default
constructor
Error
init
create
New
Session
get
All
Session
Handles
For
User
get
Session
get
Session
Information
refresh
Session
revoke
All
Sessions
For
User
revoke
Multiple
Sessions
revoke
Session
update
Access
Token
Payload
update
Session
Data
Generated using
TypeDoc