@twilio/flex-sdk
    Preparing search index...

    Class FlexDataClientError

    Represents the combined list of GraphQL errors returned from the server in a GraphQL response. This error type is used when your GraphQL operation returns errors in the errors field of the response.

    When your GraphQL operation encounters errors on the server side (such as resolver errors, validation errors, or syntax errors), the server returns these errors in the errors array of the GraphQL response. Apollo Client wraps these errors in a CombinedGraphQLErrors object, which provides access to the individual errors while maintaining additional context about the response.

    import { CombinedGraphQLErrors } from "@apollo/client/errors";

    // Check if an error is a CombinedGraphQLErrors object
    if (CombinedGraphQLErrors.is(error)) {
      // Access individual GraphQL errors
      error.errors.forEach((graphQLError) => {
        console.log(graphQLError.message);
        console.log(graphQLError.path);
        console.log(graphQLError.locations);
      });

      // Access the original GraphQL result
      console.log(error.result);
    }

    Hierarchy

    • Error
      • FlexDataClientError
    Index

    Constructors

    constructor

    Properties

    cause? data errors extensions message name stack? formatMessage stackTraceLimit

    Methods

    captureStackTrace is prepareStackTrace

    Constructors

    • Parameters

      • result: FormattedExecutionResult<any>

      Returns FlexDataClientError

    • Parameters

      • result: FormattedExecutionResult<any>
      • errors: readonly GraphQLFormattedError[]

      Returns FlexDataClientError

    Properties

    cause?: unknown
    data: Record<string, unknown> | null | undefined

    Partial data returned in the data field of the GraphQL response.

    errors: readonly GraphQLFormattedError[]

    The raw list of GraphQL errors returned by the errors field in the GraphQL response.

    extensions: Record<string, unknown> | undefined

    Extensions returned by the extensions field in the GraphQL response.

    message: string
    name: string
    stack?: string
    formatMessage: MessageFormatter

    A function that formats the error message used for the error's message property. Override this method to provide your own formatting.

    The formatMessage function is called by the CombinedGraphQLErrors constructor to provide a formatted message as the message property of the CombinedGraphQLErrors object. Follow the "Providing a custom message formatter" guide to learn how to modify the message format.

    The array of GraphQL errors returned from the server in the errors field of the response.

    Additional context that could be useful when formatting the message.

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • A method that determines whether an error is a CombinedGraphQLErrors object. This method enables TypeScript to narrow the error type.

      Parameters

      • error: unknown

      Returns error is FlexDataClientError

      if (CombinedGraphQLErrors.is(error)) {
        // TypeScript now knows `error` is a `CombinedGraphQLErrors` object
        console.log(error.errors);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods