Sent in case of any error (e.g., if the analysis fails, or the message contains syntax errors).

interface FlowrErrorMessage {
    fatal: boolean;
    id: undefined | string;
    reason: string;
    type: "error";
}

Hierarchy (view full)

Hierarchy-Diagram

UML class diagram of FlowrErrorMessage

Properties

Properties

fatal: boolean

if fatal, the connection will be partially closed afterward

id: undefined | string

The id that links a request with its responses, it is up to the calling client to make sure it is unique. However, the client does not have to pass the id if it does not need to link the request with its response. The id is always undefined if the message is unprompted (e.g., with hello) or the id unknown.

reason: string

the human-readable reason for the error

type: "error"

The at this time unknown type