TerriaError

TerriaError

new TerriaError(options)

Source:

Represents an error that occurred in a TerriaJS module, especially an asynchronous one that cannot be raised by throwing an exception because no one would be able to catch it.

Parameters:
Name Type Description
options Object

Object with the following properties:

Properties
Name Type Attributes Default Description
sender Object <optional>

The object raising the error.
title String <optional>
 'An error occurred'

A short title describing the error.
message String

A detailed message describing the error. This message may be HTML and it should be sanitized before display to the user.

Members

message :String

Source:

Gets or sets a metailed message describing the error. This message may be HTML and it should be sanitized before display to the user.

Type:
  • String

raisedToUser :Boolean

Source:
Default Value:
  • false

True if the user has seen this error; otherwise, false.

Type:
  • Boolean

sender :Object

Source:

Gets or sets the object that raised the error.

Type:
  • Object

title :String

Source:

Gets or sets a short title describing the error.

Type:
  • String