sinatra.js

Minimal Sinatra like router for your Web browser

sinatra.js uses the fragment identifier (introduced by a hash mark) of an URL for routing, making it just perfect for single page applications. Whether you’re using plain hashes or hash bangs is irrelevant in doing so—the following two URLs are treated exactly the same.

http://example.com/#/about-us
http://example.com/#!/about-us

But: sinatra.js is for web browsers only! If you’re looking for a minimal Sinatra like router for node.js, check out fapprik’s Sinodetra.

Download

To get going with sinatra.js you can:

• Download the latest release
• Install with npm: npm install sinatra
• Install with Bower: bower install sinatra

Usage

At first, embed sinatra.min.js within your Web application. sinatra.min.js is minified using Google’s Closure Compiler and weighs < 1 kB bytes if gzipped.

<script src="sinatra.min.js"></script>

That’s it, you’re able to add routes now by using the injected sinatra global.

sinatra.on('/', function(request) {
	console.log('Hello world!');
});

sinatra.on('/user/:user', function(request, user) {
	console.log('Hello, ' + user);
});

sinatra.on('/show/([0-9]+)', function(request, id) {
	console.log('Hello, ' + id);
});

As you can see, you can also use regular expressions within your route definitions. For a better readability, sinatra.js provides the opportunity to use placeholders (see :user above). However, these placeholders are nothing but a regular expression in the end.

You can disable/remove routes using sinatra.off.

sinatra.off('/show/([0-9]+)');

Of course, there’s also a way to define a callback if no routes match the requested path. This is normally used to display some fancy 404 error.

sinatra.error(function(request) {
	console.log('404 Not Found');
});

Finally, you can initialize the routing after you added all your routes using sinatra.run().

Example

sinatra.on('/', function(request) {
	console.log('Hello world!');
}).on('/say/:greeting/to/:person', function(request, greeting, person) {
	console.log(greeting + ', ' + person + '!');
}).on('/([0-9]+)/plus/([0-9]+)', function(request, one, two) {
	console.log(parseInt(one, 10) + parseInt(two, 10));
}).error(function(request) {
	console.log('404');
}).run();

Changelog

• 0.0.5
  • npm support
• 0.0.4
  • Bower support
• 0.0.3
  • Code cleanup
• 0.0.2
  • AMD support
• 0.0.1
  • Initial version

TODO

• Documentation
• Tests

License

Copyright (c) 2015 websperts
Licensed under the MIT license.

See LICENSE for more info.