anumargak

anumargak (अनुमार्गक)

Fast HTTP Router

Usage

const router = require('anumargak')({
  defaultRoute : defaultHandler,
  ignoreTrailingSlash: true
});
anumargak.on("GET", "/this/is/static", handler);
anumargak.on("GET", "/this/is/:dynamic", handler);
anumargak.on("GET", "/this/is/:dynamic", handler);//it will overwrite old mapping
anumargak.on("GET", "/this/is/:dynamic/with/:pattern(\\d+)", handler);
//Eg: params = { dynamic : val, pattern: 123}
anumargak.on("GET", "/this/is/:dynamic/with/:two-:params", handler);//use - to separate multiple parameters
anumargak.on("GET", "/this/is/:dynamic/with/:two(\\d+):params", handler);
anumargak.on("GET", "/this/is/:dynamic/with/:two(\\d+)rest", handler);
anumargak.on("GET", "/similar/:string([a-z]{10})", handler);
anumargak.on("GET", "/similar/:number([0-9]{10})", handler);//above route is different from this


anumargak.find("GET","/this/is/static");//will return handler
anumargak.find("GET","/this/is/dynamic/with/123?ignore=me");//ignore query parameters and hashtag part automatically

anumargak.lookup(req,res) ;//will execute handler with req,res and params(for dynamic URLs) as method parameters

wildcard: I couldn't understand the need of wildcard, hence not implemented. Please raise the issue if it should be implemented.

Example with server

const http = require('http')
const router = require('anumargak')()

router.on('GET', '/', (req, res, params) => {
  //process the request response here
})

const server = http.createServer((req, res) => {
  router.lookup(req, res)
})

server.listen(3000, err => {
  if (err) throw err
  console.log('Server listening on: http://localost:3000')
})

Benchmark

method	url type	anumargak (अनुमार्गक)	find-my-way
find	static	32111671.23	2939447.287
find	dynamic	2767738.28	1220416.079
find	with query param	1735181.486	1178885.798
lookup	static	29686926.23	2288805.684
lookup	dynamic	2034493.062	1023664.399
lookup	with query param	1414253.913 894684.0352

Note : Above benchmark has been taken on 16gb RAM ubuntu machine with node v9.5.0 and npm v5.6.0

Worth to mention

• NIMN निम्न : Schema aware object compression. 60% more compressed than JSON. 40% more compressed than msgpack.
• imglab : Web based tool to label images for object detection. Use it to train dlib or other object detectors. Integrated with 3rd party libraries to speed up tp process and to make you lazy.
• fast-lorem-ipsum : Generate lorem ipsum words, sentences, paragraph very quickly. Pure JS implementation.
• stubmatic : A stub server to mock behaviour of HTTP(s) / REST / SOAP services. You can easily mock msgpack, and nimn data formats as well.
• fast-xml-parser : Pure JS implementation to parse XML to JSON, JS Object, or Nimn format. Parse back from JSON, JS Object to XML. Or just validate XML syntax.
• Grapes : Flexible Regular expression engine (for java) which can be applied on char stream. (under development)
• Muneem (मुनीम): A framework to write fast web services in easy way. Designed specially for developers, QAs, Maintainers, and BAs.