Search
Preparing search index...
The search index is not available
Authist
Options
All
Public
Public/Protected
All
Inherited
Menu
Authist
authMiddleware
Module authMiddleware
Index
Type aliases
Bearer
Error
Functions
bearer
express
Bearer
express
Recover
Password
express
Refresh
Token
express
Reset
Password
Type aliases
Bearer
Error
Bearer
Error
:
Error
&
{
status
?:
number
;
statusCode
?:
number
;
toJSON
?:
any
}
Functions
Const
bearer
bearer
(
options
:
AuthistOptions
, authorization
?:
string
)
:
Promise
<
[
undefined
|
BearerError
,
undefined
|
User
]
>
Parameters
options:
AuthistOptions
Optional
authorization:
string
Returns
Promise
<
[
undefined
|
BearerError
,
undefined
|
User
]
>
Const
express
Bearer
express
Bearer
(
options
:
AuthistOptions
)
:
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
&
{
user
?:
User
}
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
options:
AuthistOptions
Returns
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
&
{
user
?:
User
}
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
&
{
user
?:
User
}
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
request:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
&
{
user
?:
User
}
response:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Const
express
Recover
Password
express
Recover
Password
(
options
:
AuthistOptions
)
:
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
options:
AuthistOptions
Returns
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
request:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
response:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Const
express
Refresh
Token
express
Refresh
Token
(
options
:
AuthistOptions
)
:
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
options:
AuthistOptions
Returns
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
request:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
response:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Const
express
Reset
Password
express
Reset
Password
(
options
:
AuthistOptions
)
:
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
options:
AuthistOptions
Returns
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
(
request
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, response
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Parameters
request:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
response:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
Promise
<
void
|
Response
<
any
,
Record
<
string
,
any
>
>
>
Modules
auth
Middleware
authist
credentials
Service
error
index
provider
Utils
reset
Password
Service
Bearer
Error
bearer
express
Bearer
express
Recover
Password
express
Refresh
Token
express
Reset
Password
Generated using
TypeDoc