api.service.HttpException

This custom exception class is provided for simplifying controller implementations.

Usage Example

Let's assume a controller component like this one:

export default function() {
	const api = this;
	const { service } = api;

	const logError = api.log( "my-app:custom:error" );

	class MyCustomController {
		static someEndpoint( req, res ) {
			try {
                if ( req.params.foo !== "expected" ) {
                    throw new service.HttpException( 400, "invalid parameter" );
                }
                
                if ( req.query.id !== "john.doe" ) {
                    throw new service.HttpException( 403, "access forbidden" );
                }
                
                // TODO provide response
                // this code might crash unexpectedly ...
            }
			catch ( { statusCode, message, stack } ) {
				logError( "request failed: %s", statusCode ? message : stack );

				res
					.status( statusCode || 500 )
					.json( { error: message } );
            }
		}
	}
}

This example is illustrating how to use HttpException in a controller of your Hitchy-based application. By wrapping up all code in a promise it's easy to commonly catch intended exceptions as well as unintended issues of your code in a single late catch handler that is providing a proper response in case of any error. Using statusCode property of provided error you can distinguish between intended errors and crashes of your code, thus providing different amounts of information in logging either case.