Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

adding missing documentation for errorResponse

This commit is contained in:
Christian Pekeler 2015-05-06 15:13:09 -06:00
parent 6dd786fb3c
commit 754e7f436c
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
js/server/modules/org/arangodb/foxx/request_context.js
View File

@ -528,10 +528,10 @@ extend(RequestContext.prototype, {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @startDocuBlock JSF_foxx_RequestContext_errorResponse /// @startDocuBlock JSF_foxx_RequestContext_errorResponse
/// ///
/// `FoxxController#errorResponse(errorClass, code, description)` /// `FoxxController#errorResponse(errorClassOrName, code, description)`
/// ///
/// Define a reaction to a thrown error for this route: If your handler throws an error /// Define a reaction to a thrown error for this route: If your handler throws an error
/// of the defined errorClass, it will be caught and the response will have the given /// of the errorClass or with the name, it will be caught and the response will have the given
/// status code and a JSON with error set to your description as the body. /// status code and a JSON with error set to your description as the body.
/// ///
/// If you want more control over the returned JSON, you can give an optional fourth /// If you want more control over the returned JSON, you can give an optional fourth
@ -547,6 +547,7 @@ extend(RequestContext.prototype, {
/// ```js /// ```js
/// /* define our own error type, FoxxyError */ /// /* define our own error type, FoxxyError */
/// var FoxxyError = function (message) { /// var FoxxyError = function (message) {
/// this.name = "FError";
/// this.message = "the following FoxxyError occurred: ' + message; /// this.message = "the following FoxxyError occurred: ' + message;
/// }; /// };
/// FoxxyError.prototype = new Error(); /// FoxxyError.prototype = new Error();
@ -558,7 +559,7 @@ extend(RequestContext.prototype, {
/// ///
/// app.get("/foxx", function { /// app.get("/foxx", function {
/// throw new FoxxyError("oops!"); /// throw new FoxxyError("oops!");
/// }).errorResponse(FoxxyError, 303, "This went completely wrong. Sorry!", function (e) { /// }).errorResponse("FError", 303, "This went completely wrong. Sorry!", function (e) {
/// return { /// return {
/// code: 123, /// code: 123,
/// desc: e.message /// desc: e.message