Error
objects are thrown when runtime errors occur. The Error
object can also be used as a base object for user-defined exceptions. See below for standard built-in error types.
Error
objects are thrown when runtime errors occur. The Error
object can also be used as a base object for user-defined exceptions. See below for standard built-in error types.
Runtime errors result in new Error
objects being created and thrown.
Error
is a serializable object, so it can be cloned with structuredClone()
or copied between Workers using postMessage()
.
Besides the generic Error
constructor, there are other core error constructors in JavaScript. For client-side exceptions, see Exception handling statements.
EvalError
Creates an instance representing an error that occurs regarding the global function eval()
.
RangeError
Creates an instance representing an error that occurs when a numeric variable or parameter is outside its valid range.
ReferenceError
Creates an instance representing an error that occurs when de-referencing an invalid reference.
SyntaxError
Creates an instance representing a syntax error.
TypeError
Creates an instance representing an error that occurs when a variable or parameter is not of a valid type.
URIError
Creates an instance representing an error that occurs when encodeURI()
or decodeURI()
are passed invalid parameters.
AggregateError
Creates an instance representing several errors wrapped in a single error when multiple errors need to be reported by an operation, for example by Promise.any()
.
InternalError
Non-standard
Creates an instance representing an error that occurs when an internal error in the JavaScript engine is thrown. E.g. "too much recursion".
Error()
Creates a new Error
object.
Error.captureStackTrace()
Non-standard
A non-standard V8 function that creates the stack
property on an Error instance.
Error.stackTraceLimit
Non-standard
A non-standard V8 numerical property that limits how many stack frames to include in an error stacktrace.
Error.prepareStackTrace()
Non-standard Optional
A non-standard V8 function that, if provided by usercode, is called by the V8 JavaScript engine for thrown exceptions, allowing the user to provide custom formatting for stacktraces.
Error.prototype.message
Error message. For user-created Error
objects, this is the string provided as the constructor's first argument.
Error.prototype.name
Error name. This is determined by the constructor function.
Error.prototype.cause
Error cause indicating the reason why the current error is thrown — usually another caught error. For user-created Error
objects, this is the value provided as the cause
property of the constructor's second argument.
Error.prototype.fileName
Non-standard
A non-standard Mozilla property for the path to the file that raised this error.
Error.prototype.lineNumber
Non-standard
A non-standard Mozilla property for the line number in the file that raised this error.
Error.prototype.columnNumber
Non-standard
A non-standard Mozilla property for the column number in the line that raised this error.
Error.prototype.stack
Non-standard
A non-standard property for a stack trace.
Error.prototype.toString()
Returns a string representing the specified object. Overrides the Object.prototype.toString()
method.
Usually you create an Error
object with the intention of raising it using the throw
keyword. You can handle the error using the try...catch
construct:
try { throw new Error('Whoops!'); } catch (e) { console.error(`${e.name}: ${e.message}`); }
You can choose to handle only specific error types by testing the error type with the error's constructor
property or, if you're writing for modern JavaScript engines, instanceof
keyword:
try { foo.bar(); } catch (e) { if (e instanceof EvalError) { console.error(`${e.name}: ${e.message}`); } else if (e instanceof RangeError) { console.error(`${e.name}: ${e.message}`); } // etc. else { // If none of our cases matched leave the Error unhandled throw e; } }
Sometimes a block of code can fail for reasons that require different handling, but which throw very similar errors (i.e. with the same type and message).
If you don't have control over the original errors that are thrown, one option is to catch them and throw new Error
objects that have more specific messages. The original error should be passed to the new Error
in the constructor option
parameter (cause
property), as this ensures that the original error and stack trace are available to higher level try/catch blocks.
The example below shows this for two methods that would otherwise fail with similar errors (doFailSomeWay()
and doFailAnotherWay()
):
function doWork() { try { doFailSomeWay(); } catch (err) { throw new Error('Failed in some way', { cause: err }); } try { doFailAnotherWay(); } catch (err) { throw new Error('Failed in another way', { cause: err }); } } try { doWork(); } catch (err) { switch(err.message) { case 'Failed in some way': handleFailSomeWay(err.cause); break; case 'Failed in another way': handleFailAnotherWay(err.cause); break; } }
Note: If you are making a library, you should prefer to use error cause to discriminate between different errors emitted — rather than asking your consumers to parse the error message. See the error cause page for an example.
Custom error types can also use the cause
property, provided the subclasses' constructor passes the options
parameter when calling super()
:
class MyError extends Error { constructor(/* some arguments */) { // Needs to pass both `message` and `options` to install the "cause" property. super(message, options); } }
You might want to define your own error types deriving from Error
to be able to throw new MyError()
and use instanceof MyError
to check the kind of error in the exception handler. This results in cleaner and more consistent error handling code.
See "What's a good way to extend Error in JavaScript?" on StackOverflow for an in-depth discussion.
Warning: Versions of Babel prior to 7 can handle CustomError
class methods, but only when they are declared with Object.defineProperty(). Otherwise, old versions of Babel and other transpilers will not correctly handle the following code without additional configuration.
Note: Some browsers include the CustomError
constructor in the stack trace when using ES2015 classes.
class CustomError extends Error { constructor(foo = 'bar', ...params) { // Pass remaining arguments (including vendor specific ones) to parent constructor super(...params); // Maintains proper stack trace for where our error was thrown (only available on V8) if (Error.captureStackTrace) { Error.captureStackTrace(this, CustomError); } this.name = 'CustomError'; // Custom debugging information this.foo = foo; this.date = new Date(); } } try { throw new CustomError('baz', 'bazMessage'); } catch (e) { console.error(e.name); // CustomError console.error(e.foo); // baz console.error(e.message); // bazMessage console.error(e.stack); // stacktrace }
Warning: All browsers include the CustomError
constructor in the stack trace when using a prototypal declaration.
function CustomError(foo, message, fileName, lineNumber) { var instance = new Error(message, fileName, lineNumber); instance.foo = foo; Object.setPrototypeOf(instance, CustomError.prototype); if (Error.captureStackTrace) { Error.captureStackTrace(instance, CustomError); } return instance; } Object.setPrototypeOf(CustomError.prototype, Error.prototype); Object.setPrototypeOf(CustomError, Error); CustomError.prototype.name = 'CustomError'; try { throw new CustomError('baz', 'bazMessage'); } catch (e) { console.error(e.name); // CustomError console.error(e.foo); // baz console.error(e.message); // bazMessage }
Specification |
---|
ECMAScript Language Specification # sec-error-objects |
Desktop | Mobile | Server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | Deno | Node.js | |
Error |
1 |
12 |
1 |
6 |
4 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
1.0 |
0.10.0 |
Error |
1 |
12 |
1 |
6 |
4 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
1.0 |
0.10.0 |
cause |
93 |
93 |
91 |
No |
No |
15 |
93 |
93 |
91 |
No |
15 |
17.0 |
1.13 |
16.9.0 |
columnNumber |
No |
No |
1 |
No |
No |
No |
No |
No |
4 |
No |
No |
No |
No |
No |
fileName |
No |
No |
1 |
No |
No |
No |
No |
No |
4 |
No |
No |
No |
No |
No |
lineNumber |
No |
No |
1 |
No |
No |
No |
No |
No |
4 |
No |
No |
No |
No |
No |
message |
1 |
12 |
1 |
6 |
5 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
1.0 |
0.10.0 |
name |
1 |
12 |
1 |
6 |
4 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
1.0 |
0.10.0 |
serializable_object |
77 |
79 |
103
["Version 103 serialized properties:
name , message , cause , fileName , lineNumber and columnNumber .", "Version 104 additionally supports serialization of stack in window.postMessage() and structuredClone() ."] |
No |
64 |
No |
77 |
77 |
103
["Version 103 serialized properties:
name , message , cause , fileName , lineNumber and columnNumber .", "Version 104 additionally supports serialization of stack in window.postMessage() and structuredClone() ."] |
55 |
No |
12.0 |
No |
No |
stack |
3 |
12 |
1 |
10 |
10.5 |
6 |
≤37 |
18 |
4 |
11 |
6 |
1.0 |
1.0 |
0.10.0 |
toString |
1 |
12 |
1 |
6 |
4 |
1 |
4.4 |
18 |
4 |
10.1 |
1 |
1.0 |
1.0 |
0.10.0 |
Error
with modern behavior like support cause
is available in core-js
throw
try...catch
Error.captureStackTrace()
, Error.stackTraceLimit
, and Error.prepareStackTrace()
.
© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error