arangojs
Version:
The official ArangoDB JavaScript driver.
189 lines • 5.04 kB
JavaScript
;
/**
* ```ts
* import type { ArangoError, HttpError } from "arangojs/error.js";
* ```
*
* The "error" module provides types and interfaces for TypeScript related
* to arangojs error handling.
*
* @packageDocumentation
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.HttpError = exports.ArangoError = exports.isSystemError = exports.isArangoErrorResponse = exports.isArangoError = void 0;
const messages = {
0: "Network Error",
304: "Not Modified",
400: "Bad Request",
401: "Unauthorized",
402: "Payment Required",
403: "Forbidden",
404: "Not Found",
405: "Method Not Allowed",
406: "Not Acceptable",
407: "Proxy Authentication Required",
408: "Request Timeout",
409: "Conflict",
410: "Gone",
411: "Length Required",
412: "Precondition Failed",
413: "Payload Too Large",
414: "Request-URI Too Long",
415: "Unsupported Media Type",
416: "Requested Range Not Satisfiable",
417: "Expectation Failed",
418: "I'm a teapot",
421: "Misdirected Request",
422: "Unprocessable Entity",
423: "Locked",
424: "Failed Dependency",
426: "Upgrade Required",
428: "Precondition Required",
429: "Too Many Requests",
431: "Request Header Fields Too Large",
444: "Connection Closed Without Response",
451: "Unavailable For Legal Reasons",
499: "Client Closed Request",
500: "Internal Server Error",
501: "Not Implemented",
502: "Bad Gateway",
503: "Service Unavailable",
504: "Gateway Timeout",
505: "HTTP Version Not Supported",
506: "Variant Also Negotiates",
507: "Insufficient Storage",
508: "Loop Detected",
510: "Not Extended",
511: "Network Authentication Required",
599: "Network Connect Timeout Error",
};
const nativeErrorKeys = [
"fileName",
"lineNumber",
"columnNumber",
"stack",
"description",
"number",
];
/**
* Indicates whether the given value represents an {@link ArangoError}.
*
* @param error - A value that might be an `ArangoError`.
*/
function isArangoError(error) {
return Boolean(error && error.isArangoError);
}
exports.isArangoError = isArangoError;
/**
* Indicates whether the given value represents an ArangoDB error response.
*
* @internal
*/
function isArangoErrorResponse(body) {
return (body &&
body.hasOwnProperty("error") &&
body.hasOwnProperty("code") &&
body.hasOwnProperty("errorMessage") &&
body.hasOwnProperty("errorNum"));
}
exports.isArangoErrorResponse = isArangoErrorResponse;
/**
* Indicates whether the given value represents a Node.js `SystemError`.
*/
function isSystemError(err) {
return (Object.getPrototypeOf(err) === Error.prototype &&
err.hasOwnProperty("code") &&
err.hasOwnProperty("errno") &&
err.hasOwnProperty("syscall"));
}
exports.isSystemError = isSystemError;
/**
* Represents an error returned by ArangoDB.
*/
class ArangoError extends Error {
name = "ArangoError";
/**
* ArangoDB error code.
*
* See [ArangoDB error documentation](https://www.arangodb.com/docs/stable/appendix-error-codes.html).
*/
errorNum;
/**
* HTTP status code included in the server error response object.
*/
code;
/**
* Server response object.
*/
response;
/**
* @internal
*/
constructor(response) {
super();
this.response = response;
this.message = response.parsedBody.errorMessage;
this.errorNum = response.parsedBody.errorNum;
this.code = response.parsedBody.code;
const err = new Error(this.message);
err.name = this.name;
for (const key of nativeErrorKeys) {
if (err[key])
this[key] = err[key];
}
}
/**
* @internal
*
* Indicates that this object represents an ArangoDB error.
*/
get isArangoError() {
return true;
}
toJSON() {
return {
error: true,
errorMessage: this.message,
errorNum: this.errorNum,
code: this.code,
};
}
}
exports.ArangoError = ArangoError;
/**
* Represents a plain HTTP error response.
*/
class HttpError extends Error {
name = "HttpError";
/**
* Server response object.
*/
response;
/**
* HTTP status code of the server response.
*/
code;
/**
* @internal
*/
constructor(response) {
super();
this.response = response;
this.code = response.status || 500;
this.message = messages[this.code] || messages[500];
const err = new Error(this.message);
err.name = this.name;
for (const key of nativeErrorKeys) {
if (err[key])
this[key] = err[key];
}
}
toJSON() {
return {
error: true,
code: this.code,
};
}
}
exports.HttpError = HttpError;
//# sourceMappingURL=error.js.map