Constructor
new MiddlewareModule()
- Source:
Extends
Methods
addTranslationUtils(req, res, next)
- Description:
- Adds translation utilities to incoming API requests
- Source:
Parameters:
| Name |
Type |
Description |
req |
external:ExpressRequest
|
|
res |
external:ExpressResponse
|
|
next |
function
|
|
bodyParserJson() → {function}
- Description:
- Parses incoming JSON data to req.body
- Source:
- See:
-
Returns:
Express middleware function
-
Type
-
function
bodyParserUrlEncoded() → {function}
- Description:
- Parses incoming URL-encoded data to req.body
- Source:
- See:
-
Returns:
Express middleware function
-
Type
-
function
configRequestHandler(_req, res)
- Description:
- Returns public config data
- Source:
Parameters:
| Name |
Type |
Description |
_req |
external:ExpressRequest
|
|
res |
external:ExpressResponse
|
|
fileUploadParser(expectedFileTypes, options) → {function}
- Description:
- Handles incoming file uploads
- Source:
Parameters:
| Name |
Type |
Description |
expectedFileTypes |
Array.<String>
|
List of file types to accept |
options |
FileUploadOptions
|
|
Returns:
The Express handler
-
Type
-
function
(async) init()
- Source:
langRequestHandler(req, res, next)
- Description:
- Returns lang strings for a specified locale
- Source:
Parameters:
| Name |
Type |
Description |
req |
external:ExpressRequest
|
|
res |
external:ExpressResponse
|
|
next |
function
|
|
(async) rateLimiter() → {function}
- Description:
- Limits how many requests indivual IPs can make
- Source:
Returns:
Express middleware function
-
Type
-
function
setDefaultFileOptions(options) → {FileUploadOptions}
- Description:
- Sets default file upload options
- Source:
Parameters:
| Name |
Type |
Description |
options |
object
|
The initial options object |
Returns:
-
Type
-
FileUploadOptions
urlUploadParser(expectedFileTypes, options) → {function}
- Description:
- Handles incoming file uploads via URL
- Source:
Parameters:
| Name |
Type |
Description |
expectedFileTypes |
Array.<String>
|
List of file types to accept |
options |
FileUploadOptions
|
|
Returns:
The Express handler
-
Type
-
function