@coding-blocks/jsonapi-server/documentation/debugging.md

A config driven NodeJS framework implementing json:api

### Debugging

Debug output is provided by the [debug](https://www.npmjs.com/package/debug) module.

The supported namespaces are:

 - jsonApi:handler:search
 - jsonApi:handler:find
 - jsonApi:handler:create
 - jsonApi:handler:delete
 - jsonApi:handler:update
 - jsonApi:validation:input
 - jsonApi:validation:output
 - jsonApi:include
 - jsonApi:filter
 - jsonApi:errors
 - jsonApi:requestCounter


To view the debugging output, provide a comma separated list (or wildcarded via `*`) of namespaces in the `DEBUG` environment variable, for example:
```
$ DEBUG=jsonApi:handler:find npm test
```
```
$ DEBUG=jsonApi:handler:* npm test
```

### Integration with application logging

If you wish to integrate `jsonapi-server` debug output with your application's logging solution, you can override the functions that are invoked for outputting the messages for the supported namespaces by invoking the package's `debugging.__overrideDebugOutput(outputFnFactory)` function where the `outputFnFactory` parameter is a function that expects a namespace string parameter and returns an output function for the namespace.

A simple example of this functionality in action would be:

```javascript
var debugging = require("jsonapi-server/lib/debugging");

var outputFnfactory = function(namespace) {
  return function(message) {
    console.log(namespace + ">>>", message);
  }
}

debugging.__overrideDebugOutput(outputFnfactory);
```