Interface GraphQLFormattedError

See: https://spec.graphql.org/draft/#sec-Errors

interface GraphQLFormattedError {
    errorInfo: null | {
        [key: string]: unknown;
    };
    errorType: string;
    extensions?: {
        [key: string]: unknown;
    };
    locations?: readonly SourceLocation[];
    message: string;
    path?: readonly (string | number)[];
}

Properties

errorInfo errorType extensions? locations? message path?

Properties

Readonly errorInfo

errorInfo: null | {
    [key: string]: unknown;
}

Additional error metadata that can be surfaced via error handling resolver utils:

Type declaration

  • [key: string]: unknown

Readonly errorType

errorType: string

The AppSync exception category. Indicates the source of the error.

Optional Readonly extensions

extensions?: {
    [key: string]: unknown;
}

Reserved for implementors to extend the protocol however they see fit, and hence there are no additional restrictions on its contents.

Type declaration

  • [key: string]: unknown

Optional Readonly locations

locations?: readonly SourceLocation[]

If an error can be associated to a particular point in the requested GraphQL document, it should contain a list of locations.

Readonly message

message: string

A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Optional Readonly path

path?: readonly (string | number)[]

If an error can be associated to a particular field in the GraphQL result, it must contain an entry with the key path that details the path of the response field which experienced the error. This allows clients to identify whether a null result is intentional or caused by a runtime error.

Settings

Member Visibility

Theme

On This Page