Interface MessageFormatterOptions

interface MessageFormatterOptions {
    defaultFormatMessage: (
        errors: readonly GraphQLFormattedError[],
    ) => string;
    result: FormattedExecutionResult<unknown>;
}

Index

Properties

defaultFormatMessage result

Properties

defaultFormatMessage

defaultFormatMessage: (errors: readonly GraphQLFormattedError[]) => string

The default message formatter. Call this to get a string with the default formatted message.

Remarks

To format part of the message using the default message formatter, call the defaultFormatMessage function provided to the options argument of your message formatter.

Example

The following example prepends a string to the message and uses the default message formatter to format the error messages.

CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {
  return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;
};

result

result: FormattedExecutionResult<unknown>

The raw result returned from the server.

Interface MessageFormatterOptions

Index

Properties

Properties

defaultFormatMessage

Remarks

Example

result

Settings

On This Page