@futdevpro/nts-dynamo 1.5.51 → 1.5.52

package/src/_services/dynamo-nts-routing-module.service.ts

@@ -11,7 +11,46 @@ import { DynamoNTS_Shared } from './dynamo-nts-shared.service';
 import { DynamoNTS_RoutingModuleSettings } from '../_models/dynamo-nts-routing-module-settings';
 
 /**
+ * Routing Module
+ * Handling route setup and control
  * 
+ * You can add routes and controllers for them
+ * @example
+ *   // Setting up Routes
+ *   setupRoutingModules(): void {
+ *     this.httpPort = env.port;
+
+ *     this.routingModules = [
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/user',
+ *         controllers: [ 
+ *           UserController.getInstance(),
+ *           UserDataController.getInstance(),
+ *           UserOptionsController.getInstance(),
+ *           UserStatisticsController.getInstance(),
+ *           UserAchievementsController.getInstance(),
+ *           UserNotificationsController.getInstance()
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/match',
+ *         controllers: [ 
+ *           MatchController.getInstance(),
+ *           MatchDistributionController.getInstance(),
+ *           MatchStatisticsController.getInstance(),
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/server',
+ *         controllers: [ 
+ *           ServerController.getInstance(),
+ *         ]
+ *       }),
+
+ *       getTestRoutingModule(),
+ *       getUsageRoutingModule()
+ *     ];
+ *   }
  */
 export class DynamoNTS_RoutingModule {