Router

Introduced in 4.0.0

Stability: 2 - Stable

const Router = require('kado/lib/Router')

The Router library provides assistance for matching paths or URIs to real locations within the system.

static Router.redirectRequest (res)

res {Response} the HTTP response
Return {Function} used to redirect requests

static Router.renderJSON (res)

res {Response} the HTTP response
Return {Function} used to render JSON responses.

static Router.sendFile (req, res)

req {Request} the HTTP request
res {Response} the HTTP response
Return {Function} used to send files to the response.

Usage:

const filepath = './foo.txt'
res.sendFile(filepath)

This method will set the Content-Length, Content-Type and ETag for the file as well as handle responding properly to HEAD requests. Useful for sending files back to the consumer.

static Router.render(app, req, res)

app {Application} an application instance
req {Request} the HTTP request
res {Response} the HTTP response
Return {Function} used to render responses with the view engine

If there is no view engine false is returned.

static Router.getRemoteIP (app, req)

app {Application} an application instance
req {Request} the HTTP request
Return {string} remote IP address.

static Router.setPoweredBy (res)

res {Response} the HTTP response
Return {void}

Sets the powered by Kado header for the response.

static Router.standardPreparation(app)

app {Application} current application instance
Return {Function} to be set as the route preparer.

static Router.getInstance()

Return {router} new instance of the router system

Router.constructor()

Return {router} new instance of the router system

Router.setPreparer(preparer)

preparer {function} used to prepare new request for routing
Return {Router} this instance

Router.getPreparer()

Return {preparer} the current registered preparation method

Router.use(fn)

fn {function} function to be called as middleware and should return a Promise.
Return {void}

Add middleware to the system to be executed before the route is called.

Router.unuse(fn)

fn {function} of middleware to be removed.
Return {boolean} true when middleware is found and removed otherwise false

Router.final(fn)

fn {function} of final handler to be added.
Return {void}

Replaces the final handler with this function. By default the final handler is a noop function.

Router.add(method, uri, fn)

method {string} HTTP verb for the route to be invoked on
uri {string} URI matching the route, special patterns are allowed.
fn {function} A function to be called by the route which should return a Promise.
Return {object} the newly added route

Adds a new route to the system with the specified handler.

Router.update(method, uri, fn)

method {string} the method of the route
uri {string} the uri of the route to modify
name {string} new name for pre-existing route
Return {string} with the updated URI

Router.remove(method, uri)

method {string} the method of the route
uri {string} the uri of the route to remove
Return {boolean} true when a route is matched and deleted, otherwise false

Router.get(httpMethod, uri, params)

httpMethod {string} the method of the route
uri {string} the uri of the route to get
params {object} blank object to be populated by found path keys
Return {object} when a route is found, otherwise {boolean} false

Router.callPreparer(req, res)

req {Request} HTTP Request object
res {Response} HTTP Response obje
Return {Promise} resolved when the preparation is complete

Internal Use

Router.callMiddleware(req, res, middlewareKeys)

req {Request} HTTP Request object
res {Response} HTTP Response object
middlewareKeys {Array} of middleware left to be called
Return {Promise} resolved when all middlewareKeys are depleted