Js-error-handler NPM

JS Error Handler

Simple script to handle js errors and send them server-side for your perusal. It catches errors and optionally sends them to your server via ajax.

Note: This library has no included dependencies. If you want the AJAX posting to work, you'll need to be including either jQuery or axios. It looks for either jQuery.post or axios.post to send the data.

Quick Start

Simply include the js-error-handler.js in your web page. It's avaialable using jsDelivr;

<script src="https://cdn.jsdelivr.net/npm/js-error-handler/dist/js-error-handler.min.js"></script>

Then intialise and configure it;

<script>
// Initiate Error Handler with no AJAX
var MyErrorHandler = new JSErrorHandler();
</script>

Additional Options

<script>
// Initiate Error Handler with options
var MyErrorHandler = new JSErrorHandler({
    ajaxURL:     '',
    ajaxProvider: axios.post, // $.post
    extraParams: {},
    onSaveError: function(error){ … },
    onSave:      function(response){ … }
});
</script>

ajaxURL (string)

The url to post the error to, without this, it will not attempt to save over ajax. Remember, if you include this option you must be including either axios or jQuery for it to work.

ajaxProvider (function)

By default, the error handler will look for axios.post or jQuery.post However, this will only work with jquery 1.5+. If this is not possible for you, you can set the ajaxProvider in the config.

The ajaxProvider MUST return a Promise so .then and .catch can run on it. You could do something like so;

ajaxProvider: myAxios.post

// This only works in jQuery 1.5+ where promises are returned
ajaxProvider: customjQueryVariable.post

ajaxProvider: new Promise(function(url, data){
    ...
});

If the ajaxProvider does not have the correct methods it will not save and you may see a warning in the console; npm.io

extraParams (object)

An object of extra parameters to send with the ajax requests, useful for sending user identifying information i.e;

extraParams: { userId: 12345 }

onError (function)

Callback function that runs when an error occurs. This fires before the saving happens.

onError: function(err) {
    // handle err
    // Save to your app local storage or something
}

onSaveError (function)

Callback function that runs when the ajax request fails. Passes one parameter to the callback which is the error that was thrown so it can be handled some other way.

onSaveError: function(err) {
    // Ajax save failed so handle it
}

onSave (function)

Callback function that runs when the save request was successful. The only parameter passed to function is the response from the ajax request.

onSave: function(err) {
    // Ajax request to save the error was successful
}

Programatically access errors

Previously the library stored the errors into sessionStorage, but to reduce dependencies and complexity this is no longer the case.

However you can still handle this yourself if you need to be able to store all errors locally using the onError callback.

You can access the array of errors that have occurred on the current page for a user by accessing the .errors property on your error handler object. This might be useful within the callback functions i.e.

<script>
// Initiate Error Handler with options
var MyErrorHandler = new JSErrorHandler({
    ajaxURL:     '/errors',
    onSaveError: function(error){

        // Failed to save, so do something else with the errors
        console.log(this.errors);

    },
});
</script>