Home Reference Source
import {GQLError} from 'neo4j-driver-core/lib/error.js'
public class | source

GQLError

Extends:

Error → GQLError

Direct Subclass:

Neo4jError
this class is experimental. this class is part of the preview of GQL-compliant errors

Class for nested errors, to be used as causes in Neo4jError

Constructor Summary

Public Constructor
public

constructor(message: string, gqlStatus: string, gqlStatusDescription: string, diagnosticRecord: ErrorDiagnosticRecord, cause: Error)

Member Summary

Public Members
public

cause: Error?

Optional, nested error which caused the error

public
this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL error classification, extracted from the diagnostic record

public

diagnosticRecord: DiagnosticRecord

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL diagnostic record

public get
this get is experimental. this is part of the preview of GQL-compliant errors

The json string representation of the diagnostic record.

public

gqlStatus: string

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL Status code

public
this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL Status Description

public

name: string

public
this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL error classification, extracted from the diagnostic record as a raw string

Public Constructors

public constructor(message: string, gqlStatus: string, gqlStatusDescription: string, diagnosticRecord: ErrorDiagnosticRecord, cause: Error) source

Params:

NameTypeAttributeDescription
message string

the error message

gqlStatus string

the GQL status code of the error

gqlStatusDescription string

the GQL status description of the error

diagnosticRecord ErrorDiagnosticRecord

the error diagnostic record

cause Error

Optional nested error, the cause of the error

Public Members

public cause: Error? source

Optional, nested error which caused the error

public classification: ErrorClassification source

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL error classification, extracted from the diagnostic record

public diagnosticRecord: DiagnosticRecord source

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL diagnostic record

public get diagnosticRecordAsJsonString: string source

this get is experimental. this is part of the preview of GQL-compliant errors

The json string representation of the diagnostic record. The goal of this method is provide a serialized object for human inspection.

public gqlStatus: string source

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL Status code

public gqlStatusDescription: string source

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL Status Description

public name: string source

public rawClassification: string source

this member is experimental. this property is part of the preview of GQL-compliant errors

The GQL error classification, extracted from the diagnostic record as a raw string