Axinom Mosaic Libraries
    Preparing search index...

    Interface GraphQLError

    GraphQL based interface for an error.

    GraphQL npm library

    interface GraphQLError {
        extensions: { [key: string]: any } | undefined;
        locations: readonly { column: number; line: number }[] | undefined;
        message: string;
        nodes: readonly unknown[] | undefined;
        originalError: Error | null | undefined;
        path: readonly (string | number)[] | undefined;
        positions: readonly number[] | undefined;
        source:
            | {
                body: string;
                locationOffset: { column: number; line: number };
                name: string;
            }
            | undefined;
    }

    Hierarchy (View Summary)

    Index

    Properties

    extensions locations message nodes originalError path positions source

    Properties

    extensions: { [key: string]: any } | undefined

    Extension fields to add to the formatted error.

    locations: readonly { column: number; line: number }[] | undefined

    An array of { line, column } locations within the source GraphQL document which correspond to this error.

    Errors during validation often contain multiple locations, for example to point out two things with the same name. Errors during execution include a single location, the field which produced the error.

    Enumerable, and appears in the result of JSON.stringify().

    message: string

    A message describing the Error for debugging purposes.

    Enumerable, and appears in the result of JSON.stringify().

    Note: should be treated as readonly, despite invariant usage.

    nodes: readonly unknown[] | undefined

    An array of GraphQL AST Nodes corresponding to this error.

    originalError: Error | null | undefined

    The original error thrown from a field resolver during execution.

    path: readonly (string | number)[] | undefined

    An array describing the JSON-path into the execution response which corresponds to this error. Only included for errors during execution.

    Enumerable, and appears in the result of JSON.stringify().

    positions: readonly number[] | undefined

    An array of character offsets within the source GraphQL document which correspond to this error.

    source:
        | {
            body: string;
            locationOffset: { column: number; line: number };
            name: string;
        }
        | undefined

    The source GraphQL document corresponding to this error.

    Note that if this Error represents more than one node, the source may not represent nodes after the first node.

    Settings

    Member Visibility

    On This Page

    Properties