DispatchJS

A very simple dispatcher for nodejs servers.

Sample usage:

var dispatch = require('dispatchjs');

dispatch.map('GET', '^/?$', function() {
	this('Hello world!', { 'Content-Type': 'text/plain' });
});

dispatch.map('POST', '/upload', function() {
	console.log(this.files);
	this('Thank you.');
});

dispatch();

Methods

dispatch.map(METHODS, [REGEX,] CALLBACK);

METHODS are the names of the HTTP METHOD you want to respond to. It can be an array with the list of methods or a string for a single type of method. Most common methods are 'GET' and 'POST'. You can use '*' to describe any method. You may also designate the INTEGER 404 as a method to handle non-matched requests.

REGEX is the page to respond to. It will be matched using the nodejs String.match() function. The '^' is automatically prepended to the regex if none is provided. No '$' are automatically added. If this variable is ommited, the value considered will be '' (empty string). Be aware that an empty string will probably match anything.

If a match is found, the function gets called and the matches will be available at this.matches variable.

CALLBACK is the function to call if the METHOD and REGEX are valid. To the function are passed the parameters req and res, like function(req, res) {}. But they also can be accessed within the function as this.req and this.res.

this is an auxiliary function to respond to the request. It ends the connection on calling and no further information can be sent to the client.

format: this(DATA [, HEADERS]);

variables:

• this.ret
• this.req
• this.matches
• this.dispatch -- the main Dispatch function
• this.fields -- if it's a POST method, it parses the fields of the form, if any (using formidable).
• this.files -- uploaded files, if any (using formidable).
• this.headers -- the parsed headers of the request
• this.statusCode -- the HTTP code to pass on to the requester. Default is 200, unless the method being called is 404 (which defaults to 404).

dispatch.setOption(KEY, VALUE);

Set an individual option.

dispatch.setOption(DICTIONARY);

Sets a lists of options.

dispatch([PORT[, OPTIONS]]);

Invokes the http server and start serving on the given PORT. Default port value is 3000.

Options is an object with the following valid parameters:

• gzip_compress (string): 'no', 'always', 'auto' (default) -- compresses the result using zlib when accepted by the requestes
• serve_static (boolean/string): false (bool, default), true (bool), <string> (string with path to serve, relative to the main module file)
• debug (boolean): false (default), true

License

MIT