This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

Error

Summary

Contains information about errors.

Syntax

errorObj = new Error()

errorObj = new Error([ number ])

errorObj = new Error([ number [, description ]])
errorObj
Required. The variable name to which the Error object is assigned.
number
Optional. Numeric value assigned to an error. Zero if omitted.
description
Optional. Brief string that describes an error. Empty string if omitted.

Examples

The following example illustrates the use of the Error object.

function checkInput(x) {
     try
     {
         if (isNaN(parseInt(x))) {
             throw new Error("Input is not a number.");
         }
     }
     catch(e)
     {
         document.write(e.description);
     }
 }

The following example illustrates the use of the implicitly created Error object.

try
    {
    // Cause an error.
    x = y;
    }
 catch(e)
    {
       document.write(e);
       document.write ("<br />");

       document.write ("Number: ");
       document.write (e.number & 0xFFFF);
       document.write ("<br />");

       document.write ("Facility Code: ");
       document.write(e.number>>16 & 0x1FFF);
       document.write ("<br />");

       document.write ("Description: ");
       document.write (e.description);
    }

 // Output:
 // ReferenceError: 'y' is undefined
 // Facility Code: 10
 // Number: 5009
 // Description: 'y' is undefined

Remarks

Whenever a run-time error occurs, an instance of the Error object is created to describe the error. This instance has two intrinsic properties that contain the description of the error ( description property) and the error number ( number property).

An error number is a 32-bit value. The upper 16-bit word is the facility code, while the lower word is the actual error code.

Error objects can also be explicitly created, using the syntax shown above, or thrown using the throw statement. In both cases, you can add any properties you choose to expand the capability of the Error object.

Typically, the local variable that is created in a try…catch statement refers to the implicitly created Error object. As a result, you can use the error number and description in any way you choose.

Methods

toString Method (Error) | valueOf Method (Date)

Properties

constructor Property (Error) | number Property | prototype Property (Error) | stack Property (Error) | stackTraceLimit Property (Error)

See also

Other articles

Attributions

  • Microsoft Developer Network: Article