@graphty/graphty-element / index / GraphtyErrorJson
Interface: GraphtyErrorJson ​
Defined in: graphty-element/src/errors/GraphtyError.ts:73
What a GraphtyError looks like once it has been serialised.
Plain JSON: safe to log, to post across a worker boundary, and to put in a bug report.
Properties ​
causeMessage? ​
optionalcauseMessage?:string
Defined in: graphty-element/src/errors/GraphtyError.ts:89
The wrapped failure's message, when there was one. The original object is not serialised.
code ​
code:
GraphtyErrorCode
Defined in: graphty-element/src/errors/GraphtyError.ts:77
The machine-readable reason.
details ​
details:
Readonly<Record<string,unknown>>
Defined in: graphty-element/src/errors/GraphtyError.ts:85
The structured facts behind the failure.
message ​
message:
string
Defined in: graphty-element/src/errors/GraphtyError.ts:79
The human-readable message.
name ​
name:
string
Defined in: graphty-element/src/errors/GraphtyError.ts:75
Always "GraphtyError", so a log reader can tell what it is looking at.
recoverable ​
recoverable:
boolean
Defined in: graphty-element/src/errors/GraphtyError.ts:83
Whether retrying unchanged could succeed.
source ​
source:
GraphtyErrorSource
Defined in: graphty-element/src/errors/GraphtyError.ts:81
The area of the element that failed.
target? ​
optionaltarget?:GraphtyErrorTarget
Defined in: graphty-element/src/errors/GraphtyError.ts:87
The run, layer or scope the failure belongs to, when it belongs to one.