Skip to content

klammbueddel/catchall

 
 

Repository files navigation

Motivation

  • Catches all exceptions thrown in JavaScript.
  • Catch errors where they originate from.
  • Ability to log, and send errors to a server while alpha testing.
  • Insipired by proxino, and node.js's uncaughtException event.
  • Identify where try/catch blocks are used where they shouldn't be.

Features

  • Wrapped scripts are cached until they're modified.
  • Connect Middleware
  • beanpoll Plugin
  • Works with mesh

Super Important Note

All functions are wrapped in try-catch blocks, so it would be a terrible idea to use this for production code.

Example

Create a file called script.js:

//only catch all if functions have been wrapped around
if(typeof catchall != 'undefined') {

	//on catch all, send error to server
	catchall.onerror = function(e) {
		console.error('An error has occurred!');
		console.error(e.message);
	}	
}


function badFunction() {
	unknownFunction();
}

badFunction();

In terminal, type:

catchall -i ./script.js -o ./script.guarded.js
node ./script.guarded.js

The message you should see is:

An error has occurred!
unknownFunction is not defined

Command Line Usage

Usage: -i [input_js]

Options:
  -i, --input   input js file or url  [required]
  -o, --output  output js file      

Connect Middleware

var catchall = require('catchall'),
connect      = require('connect'),
app          = connect.createServer();

app.use(catchall.connectMiddleware);
app.use(connect.static(__dirname + '/public'));
app.listen(80);

Here's how you'd use catchall in html:

<html>
  <head>

    <!-- from remote url -->
    <script type="text/javascript" src="http://127.0.0.1/catchall/http://site.com/scr.js"></script>

    <!-- from local server -->
    <script type="text/javascript" src="http://127.0.0.1/catchall/js/public/script.js"></script>
  </head>
  <body>
  </body>
</html>

API

catchall.wrap(source[, ops], callback)

Generates guarded code where all exceptions are caught.

  • source - the javascript source to wrap around
  • ops - the wrap options
    • add_handler - add the handler at the head of the script (catchall.onerror = function(){})
    • uglify - uglify the script by removing all whitespace
    • indent_level - indentation in spaces

Here's a simple example:

var catchall = require('catchall');

catchall.wrap('function test(){ notDefined(); }', function(err, wrappedSource) {
	//do stuff
});

The above script will produce:

function test() {
	try {
		notDefined();
	} catch(e) {
		catchall.onerror(e);
	}
}

catchall.load(source[, ops], callback)

Loads the given source, and wraps around it. Can be from fs, or url.

Example:

catchall.load('http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.js', function(err, result) {
	//do something
});

catchall.load('/from/fs', function(err, result) {
	//do something
});

About

catch all javascript errors

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.6%
  • Makefile 2.4%