new JmapError(payload, methodopt)
A JmapError
is a custom Error
thrown when a request is rejected by the JMAP backend.
The type property holds the type of error that happened. Refer to the JMAP spec
for details on the available errors.
Other properties may be present with further information; these are detailed in the method descriptions where appropriate.
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
payload |
Object | The error payload, from which detailed information about the error can be retrieved. Properties
|
|||||||||||||||||
method |
String |
<optional> |
null | The JMAP method that triggered this |
- Source:
- See:
-
- Error
Methods
toString() → {String}
Returns a String representation of this JmapError
.
- Source:
Returns:
The human-readable representation of this JmapError
.
- Type
- String