Interface IRouter

param

• param(name: string, handler: "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler): "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".IRouter
• param(callback: (name: string, matcher: RegExp) => "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler): "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".IRouter

• Map the given param placeholder name(s) to the given callback(s).

  Parameter mapping is used to provide pre-conditions to routes which use normalized placeholders. For example a :user_id parameter could automatically load a user's information from the database without any additional code,

  The callback uses the samesignature as middleware, the only differencing being that the value of the placeholder is passed, in this case the id of the user. Once the next() function is invoked, just like middleware it will continue on to execute the route, or subsequent parameter functions.

   app.param('user_id', function(req, res, next, id){
     User.find(id, function(err, user){
       if (err) {
         next(err);
       } else if (user) {
         req.user = user;
         next();
       } else {
         next(new Error('failed to load user'));
       }
     });
   });
  

  Parameters

  • name: string

  • handler: "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler

  Returns "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".IRouter

• Alternatively, you can pass only a callback, in which case you have the opportunity to alter the app.param()

  deprecated

  since version 4.11

  Parameters

  • callback: (name: string, matcher: RegExp) => "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler

    • • (name: string, matcher: RegExp): "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler

      • Parameters

        • name: string

        • matcher: RegExp

        Returns "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".RequestParamHandler

  Returns "/home/runner/work/forge/forge/node_modules/@types/express-serve-static-core/index".IRouter