libflitter/templates/router.js

  1. /**
  2.  * @module libflitter/templates/router
  3.  */
  5. /**
  6.  * Get the contents of a new router definition file with the specified object name.
  7.  * @param {string} name - the name of the router definition object
  8.  * @returns {string}
  9.  */
  10. module.exports = exports = (name) => {
  11.     return `/*
  12.  * ${name} Routes
  13.  * -------------------------------------------------------------
  14.  * Put some description here!
  15.  */
  16. const ${name} = {
  18.     /*
  19.      * Define the prefix applied to each of these routes.
  20.      * For example, if prefix is '/auth':
  21.      *      '/' becomes '/auth'
  22.      *      '/login' becomes '/auth/login'
  23.      */
  24.     prefix: '/${name.toLowerCase()}',
  25.     
  26.     /*
  27.      * Define middleware that should be applied to all
  28.      * routes defined in this file. Middleware should be
  29.      * included using Flitter's global mw() function, but
  30.      * it can also be added directly using require().
  31.      */
  32.     middleware: [
  33.         // 'Middleware Name',
  34.     ],
  36.     /*
  37.      * Define GET routes.
  38.      * These routes are registered as GET methods.
  39.      * Handlers for these routes should be specified as
  40.      * an array of functions that are applied in order.
  41.      *
  42.      * You should refer to middleware and controller methods
  43.      * by their fully-qualified canonical names. For example:
  44.      *
  45.      *     controller::auth:Forms.login_get
  46.      *     middleware::auth:UserOnly
  47.      */
  48.     get: {
  49.         // '/': ['controller::Controller_Name.handler_name'],
  50.     },
  52.     /*
  53.      * Define POST routes.
  54.      * These routes are registered as POST methods.
  55.      * Handlers for these routes should be specified as
  56.      * an array of functions that are applied in order.
  57.      *
  58.      * mw() calls apply Flitter middleware
  59.      * controller() calls get methods in Flitter controllers
  60.      */
  61.     post: {
  63.     },
  64.     
  65.     // Supports get, post, patch, put, delete, &c.
  66. }
  68. module.exports = exports = ${name}`
  69. }
JAVASCRIPT
Copied!