# Class Error

- [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [TopLevel.Error](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md)

Error represents a generic exception.

## All Known Subclasses

[APIException](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.APIException.md)

## Property Summary

| Property                                                                                                | Description                                                 |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [message](#message): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) | An error message that provides details about the exception. |
| [name](#name): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)       | The name of the error based on the constructor used.        |
| [stack](#stack): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)     | The script stack trace.                                     |

## Constructor Summary

| Constructor                                                                                               | Description                                               |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [Error](#error)()                                                                                         | Constructs the Error object.                              |
| [Error](#errorstring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Constructs the Error object  using the specified message. |

## Method Summary

| Method                                                                                                                                                                                                                                                                                                        | Description                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| static [captureStackTrace](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md#capturestacktraceerror-function)([Error](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md), [Function](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Function.md)) | Fills the [stack](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md#stack) property for the passed error. |
| [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md#tostring)()                                                                                                                                                                                                                | Returns a String representation of the Error.                                                                                   |

### Methods inherited from class Object

[assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)

## Property Details

### message

- message: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : An error message that provides details about the exception.

***

### name

- name: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : The name of the error based on the constructor used.

***

### stack

- stack: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : The script stack trace.

    This property is filled on throwing or via an explicit call [captureStackTrace(Error, Function)](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md#capturestacktraceerror-function).

***

## Constructor Details

### Error()

- Error()
  - : Constructs the Error object.

***

### Error(String)

- Error(msg: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md))
  - : Constructs the Error object
    using the specified message.

    **Parameters:**

    - msg - the message to use,.

***

## Method Details

### captureStackTrace(Error, Function)

- static captureStackTrace(error: [Error](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md), constructorOpt: [Function](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Function.md)): void
  - : Fills the [stack](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Error.md#stack) property for the passed error.

    The optional constructorOpt parameter allows you to pass in a function value. When collecting the stack trace all
    frames above the topmost call to this function, including that call, are left out of the stack trace. This can be
    useful to hide implementation details that won’t be useful to the user. The usual way of defining a custom error
    that captures a stack trace would be:

    ```
    function MyError() {
        // fill the stack trace, but hide the call to MyError
        Error.captureStackTrace(this, MyError);
    }
    ```

    **Parameters:**

    - error - The error whose stack trace should be filled.
    - constructorOpt - An optional filter to hide the topmost stack frames.

    **API Version:**

:::note
Available from version 21.2.
:::

***

### toString()

- toString(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns a String representation of the Error.

    **Returns:**

    - a String representation of the Error.

***