Route Utility for Satoshi Showdown. This module serves as a centralized point for consolidating and applying route handling within the Express application. It is responsible for importing route modules that cater to different functional aspects of the application, such as user management, event handling, and webhook processing. This organization facilitates a modular and maintainable routing structure, ensuring that application routes are systematically structured and easily scalable.
This module also includes a health check endpoint for monitoring the application's operational status, which is crucial for ensuring the reliability and availability of the service.
- Source:
Requires
- module:express.Application
- module:routes/userRoutes
- module:routes/eventRoutes
- module:routes/webhookRoutes
Methods
(inner) applyRoutes(app)
Integrates various route modules into the Express application. This function systematically adds each group of route handlers to the application instance, segregating them based on their functional domain. Additionally, it establishes a health check endpoint, allowing for routine health and performance monitoring of the application.
The health check endpoint is a lightweight and responsive route that returns a standard success response, signifying the operational status of the application.
Parameters:
| Name | Type | Description |
|---|---|---|
app |
express.Application | The Express application to which routes will be applied. |
- Source: