Interface IRouter

all

checkout

connect

copy

delete

get

head

link

lock

m-search

merge

mkactivity

mkcol

move

notify

options

patch

post

propfind

proppatch

purge

put

report

search

stack

subscribe

trace

unlink

unlock

unsubscribe

use

param

• param(name, handler): this

• 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'));
       }
     });
   });
  Copy

  Parameters

  • name: string
  • handler: RequestParamHandler

  Returns this
• param(callback): this

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

  Parameters

  • callback: Object

  Returns this

  Deprecated

  since version 4.11

route

• route<T>(prefix): IRoute<T>

• Type Parameters

  • T extends string

  Parameters

  • prefix: T

  Returns IRoute<T>

• route(prefix): IRoute<string>

• Parameters

  • prefix: PathParams

  Returns IRoute<string>