@apollo/client 4.0.0-rc.1 → 4.0.0-rc.11

package/errors/CombinedGraphQLErrors.d.ts

@@ -1,37 +1,191 @@
 import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
-import type { FetchResult } from "@apollo/client";
+import type { ApolloLink } from "@apollo/client/link";
 export declare namespace CombinedGraphQLErrors {
     interface MessageFormatterOptions {
-        result: FetchResult<unknown>;
+        /**
+         * The raw result returned from the server.
+         */
+        result: ApolloLink.Result<unknown>;
+        /**
+         * 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.
+         *
+         * ```ts
+         * CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+         *   return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;
+         * };
+         * ```
+         */
         defaultFormatMessage: (errors: ReadonlyArray<GraphQLFormattedError>) => string;
     }
+    /**
+     * By default, `CombinedGraphQLErrors` formats the `message` property by
+     * joining each error's `message` field with a newline. To customize the
+     * format of the `message`, such as changing the delimiter or adding a message
+     * prefix, override the static `formatMessage` method.
+     *
+     * @example
+     *
+     * The following example demonstrates how to format the error message by
+     * joining each error with a comma.
+     *
+     * ```ts
+     * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+     *
+     * CombinedGraphQLErrors.formatMessage = (errors) => {
+     *   return errors.map((error) => error.message).join(", ");
+     * };
+     * ```
+     *
+     * @remarks
+     *
+     * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#formatmessage) docs for details about the parameters provided to the `formatMessage` function.
+     *
+     * > [!NOTE]
+     * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.
+     *
+     * @param errors - The array of GraphQL errors returned from the server in the
+     * `errors` field of the response.
+     * @param options - Additional context that could be useful when formatting
+     * the message.
+     */
     type MessageFormatter = (errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions) => string;
+    namespace DocumentationTypes {
+        /**
+         * A function that formats the error message used for the error's `message`
+         * property. Override this method to provide your own formatting.
+         *
+         * @remarks
+         *
+         * 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"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+         *
+         * @param errors - The array of GraphQL errors returned from the server in
+         * the `errors` field of the response.
+         * @param options - Additional context that could be useful when formatting
+         * the message.
+         */
+        function formatMessage(errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions): string;
+        interface InstanceProperties {
+            /**
+             * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+             */
+            readonly errors: ReadonlyArray<GraphQLFormattedError>;
+            /**
+             * Partial data returned in the `data` field of the GraphQL response.
+             */
+            readonly data: Record<string, unknown> | null | undefined;
+            /**
+             * Extensions returned by the `extensions` field in the GraphQL response.
+             */
+            readonly extensions: Record<string, unknown> | undefined;
+        }
+        /**
+         * A method that determines whether an error is a `{{errorClass}}`
+         * object. This method enables TypeScript to narrow the error type.
+         *
+         * @example
+         *
+         * ```ts
+         * if ({{errorClass}}.is(error)) {
+         *   // TypeScript now knows `error` is a `{{errorClass}}` object
+         *   console.log(error.errors);
+         * }
+         * ```
+         */
+        function is(error: unknown): boolean;
+    }
 }
 /**
  * Represents the combined list of GraphQL errors returned from the server in a
- * GraphQL response.
+ * GraphQL response. This error type is used when your GraphQL operation returns
+ * errors in the `errors` field of the response.
+ *
+ * @remarks
+ *
+ * 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.
+ *
+ * @example
+ *
+ * ```ts
+ * 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);
+ * }
+ * ```
  */
 export declare class CombinedGraphQLErrors extends Error {
-    /** Determine if an error is a `CombinedGraphQLErrors` instance */
+    /**
+    * A method that determines whether an error is a `CombinedGraphQLErrors`
+    * object. This method enables TypeScript to narrow the error type.
+    * 
+    * @example
+    * 
+    * ```ts
+    * if (CombinedGraphQLErrors.is(error)) {
+    *   // TypeScript now knows `error` is a `CombinedGraphQLErrors` object
+    *   console.log(error.errors);
+    * }
+    * ```
+    */
     static is(error: unknown): error is CombinedGraphQLErrors;
     /**
-     * Formats the error message used for the error `message` property. Override
-     * to provide your own formatting.
-     */
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * 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"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in
+    * the `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
     static formatMessage: CombinedGraphQLErrors.MessageFormatter;
     /**
-     * The raw list of GraphQL errors returned in a GraphQL response.
-     */
+    * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+    */
     readonly errors: ReadonlyArray<GraphQLFormattedError>;
     /**
-     * Partial data returned in the GraphQL response.
-     */
+    * Partial data returned in the `data` field of the GraphQL response.
+    */
     readonly data: Record<string, unknown> | null | undefined;
     /**
-     * Extensions added to the result.
-     */
+    * Extensions returned by the `extensions` field in the GraphQL response.
+    */
     readonly extensions: Record<string, unknown> | undefined;
     constructor(result: FormattedExecutionResult<any>);
-    constructor(result: FetchResult<any>, errors: ReadonlyArray<GraphQLFormattedError>);
+    constructor(result: ApolloLink.Result<any>, errors: ReadonlyArray<GraphQLFormattedError>);
 }
 //# sourceMappingURL=CombinedGraphQLErrors.d.ts.map

package/errors/CombinedGraphQLErrors.js

@@ -8,29 +8,82 @@ function defaultFormatMessage(errors) {
 }
 /**
  * Represents the combined list of GraphQL errors returned from the server in a
- * GraphQL response.
+ * GraphQL response. This error type is used when your GraphQL operation returns
+ * errors in the `errors` field of the response.
+ *
+ * @remarks
+ *
+ * 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.
+ *
+ * @example
+ *
+ * ```ts
+ * 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);
+ * }
+ * ```
  */
 export class CombinedGraphQLErrors extends Error {
-    /** Determine if an error is a `CombinedGraphQLErrors` instance */
+    /**
+    * A method that determines whether an error is a `CombinedGraphQLErrors`
+    * object. This method enables TypeScript to narrow the error type.
+    * 
+    * @example
+    * 
+    * ```ts
+    * if (CombinedGraphQLErrors.is(error)) {
+    *   // TypeScript now knows `error` is a `CombinedGraphQLErrors` object
+    *   console.log(error.errors);
+    * }
+    * ```
+    */
     static is(error) {
         return isBranded(error, "CombinedGraphQLErrors");
     }
     /**
-     * Formats the error message used for the error `message` property. Override
-     * to provide your own formatting.
-     */
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * 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"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in
+    * the `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
     static formatMessage = defaultFormatMessage;
     /**
-     * The raw list of GraphQL errors returned in a GraphQL response.
-     */
+    * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+    */
     errors;
     /**
-     * Partial data returned in the GraphQL response.
-     */
+    * Partial data returned in the `data` field of the GraphQL response.
+    */
     data;
     /**
-     * Extensions added to the result.
-     */
+    * Extensions returned by the `extensions` field in the GraphQL response.
+    */
     extensions;
     constructor(result, errors = result.errors || []) {
         super(CombinedGraphQLErrors.formatMessage(errors, {

package/errors/CombinedGraphQLErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"CombinedGraphQLErrors.js","sources":["../../src/errors/CombinedGraphQLErrors.ts"],"sourcesContent":["import type { FormattedExecutionResult, GraphQLFormattedError } from \"graphql\";\n\nimport type { FetchResult } from \"@apollo/client\";\n\nimport { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace CombinedGraphQLErrors {\n  export interface MessageFormatterOptions {\n    result: FetchResult<unknown>;\n    defaultFormatMessage: (\n      errors: ReadonlyArray<GraphQLFormattedError>\n    ) => string;\n  }\n\n  export type MessageFormatter = (\n    errors: ReadonlyArray<GraphQLFormattedError>,\n    options: MessageFormatterOptions\n  ) => string;\n}\n\nfunction defaultFormatMessage(errors: ReadonlyArray<GraphQLFormattedError>) {\n  return (\n    errors\n      // Handle non-spec-compliant servers: See #1185\n      .filter((e) => e)\n      .map((e) => e.message || \"Error message not found.\")\n      .join(\"\\n\")\n  );\n}\n\n/**\n * Represents the combined list of GraphQL errors returned from the server in a\n * GraphQL response.\n */\nexport class CombinedGraphQLErrors extends Error {\n  /** Determine if an error is a `CombinedGraphQLErrors` instance */\n  static is(error: unknown): error is CombinedGraphQLErrors {\n    return isBranded(error, \"CombinedGraphQLErrors\");\n  }\n\n  /**\n   * Formats the error message used for the error `message` property. Override\n   * to provide your own formatting.\n   */\n  static formatMessage: CombinedGraphQLErrors.MessageFormatter =\n    defaultFormatMessage;\n\n  /**\n   * The raw list of GraphQL errors returned in a GraphQL response.\n   */\n  readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n  /**\n   * Partial data returned in the GraphQL response.\n   */\n  readonly data: Record<string, unknown> | null | undefined;\n\n  /**\n   * Extensions added to the result.\n   */\n  readonly extensions: Record<string, unknown> | undefined;\n\n  constructor(result: FormattedExecutionResult<any>);\n  constructor(\n    result: FetchResult<any>,\n    errors: ReadonlyArray<GraphQLFormattedError>\n  );\n\n  constructor(\n    result: FetchResult<any> | FormattedExecutionResult<any>,\n    errors = (result as FormattedExecutionResult<any>).errors || []\n  ) {\n    super(\n      CombinedGraphQLErrors.formatMessage(errors, {\n        result,\n        defaultFormatMessage,\n      })\n    );\n    this.errors = errors;\n    this.data = (result as Partial<FormattedExecutionResult>).data;\n    this.extensions = (result as Partial<FormattedExecutionResult>).extensions;\n    this.name = \"CombinedGraphQLErrors\";\n\n    brand(this);\n    Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);\n  }\n}\n"],"names":[],"mappings":"AAIA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AAgB7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAA0E,EAA1E;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CACL,CADJ,CAAA,CAAA,CAAA,CAAA;QAEM,CAAN,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACA,CAAO,CAAP,CAAA,CAAA,CAAA,CAAA,CAAa,CAAC,CAAC,CAAC,EAAE,CAAlB,EAAqB,CAAC;QACtB,CAAO,CAAP,CAAA,CAAU,CAAC,CAAC,CAAC,EAAE,CAAf,EAAkB,CAAC,CAAC,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD;QACzD,CAAO,CAAP,CAAA,CAAA,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAgB,CAAC,CACd;AACH;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA2C,CAA3C,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmD,CAAC;IAClD;IAEA,CAAF,CAAA;;;KAGA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACwB;IAEtB,CAAF,CAAA;;KAEA,CAAA;IACW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA;;KAEA,CAAA;IACW,CAAX,CAAA,CAAA,CAAe;IAEb,CAAF,CAAA;;KAEA,CAAA;IACW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;IAQnB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAC4D,EACxD,CAFJ,CAAA,CAAA,CAAA,CAAA,EAAA,EAEc,CAFd,CAAA,CAAA,CAAA,CAAA,CAEsD,CAAC,CAFvD,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAEiE,CAFjE,CAEmE,EAFnE;QAII,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC2B,CAAC,CAD5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACyC,CAAC,CAD1C,CAAA,CAAA,CAAA,CAAA,CACgD,EAAE;YAC1C,CAAR,CAAA,CAAA,CAAA,CAAA,CAAc;YACN,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QAC5B,CAAO,CAAC,CACH;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB;QACpB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAiB,CAAjB,CAAA,CAAA,CAAA,CAAA,CAA6D,CAAC,CAA9D,CAAA,CAAA,CAAkE;QAC9D,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAmE,CAAC,CAApE,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8E;QAC1E,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC;QAEnC,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC,CAAtD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC;IAC9D;;"}
+{"version":3,"file":"CombinedGraphQLErrors.js","sources":["../../src/errors/CombinedGraphQLErrors.ts"],"sourcesContent":["import type { FormattedExecutionResult, GraphQLFormattedError } from \"graphql\";\n\nimport type { ApolloLink } from \"@apollo/client/link\";\n\nimport { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace CombinedGraphQLErrors {\n  export interface MessageFormatterOptions {\n    /**\n     * The raw result returned from the server.\n     */\n    result: ApolloLink.Result<unknown>;\n\n    /**\n     * The default message formatter. Call this to get a string with the default\n     * formatted message.\n     *\n     * @remarks\n     * To format part of the message using the default message formatter, call\n     * the `defaultFormatMessage` function provided to the `options` argument of\n     * your message formatter.\n     *\n     * @example\n     *\n     * The following example prepends a string to the message and uses the\n     * default message formatter to format the error messages.\n     *\n     * ```ts\n     * CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {\n     *   return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;\n     * };\n     * ```\n     */\n    defaultFormatMessage: (\n      errors: ReadonlyArray<GraphQLFormattedError>\n    ) => string;\n  }\n\n  /**\n   * By default, `CombinedGraphQLErrors` formats the `message` property by\n   * joining each error's `message` field with a newline. To customize the\n   * format of the `message`, such as changing the delimiter or adding a message\n   * prefix, override the static `formatMessage` method.\n   *\n   * @example\n   *\n   * The following example demonstrates how to format the error message by\n   * joining each error with a comma.\n   *\n   * ```ts\n   * import { CombinedGraphQLErrors } from \"@apollo/client/errors\";\n   *\n   * CombinedGraphQLErrors.formatMessage = (errors) => {\n   *   return errors.map((error) => error.message).join(\", \");\n   * };\n   * ```\n   *\n   * @remarks\n   *\n   * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#formatmessage) docs for details about the parameters provided to the `formatMessage` function.\n   *\n   * > [!NOTE]\n   * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.\n   *\n   * @param errors - The array of GraphQL errors returned from the server in the\n   * `errors` field of the response.\n   * @param options - Additional context that could be useful when formatting\n   * the message.\n   */\n  export type MessageFormatter = (\n    errors: ReadonlyArray<GraphQLFormattedError>,\n    options: MessageFormatterOptions\n  ) => string;\n\n  namespace DocumentationTypes {\n    /**\n     * A function that formats the error message used for the error's `message`\n     * property. Override this method to provide your own formatting.\n     *\n     * @remarks\n     *\n     * The `formatMessage` function is called by the `CombinedGraphQLErrors`\n     * constructor to provide a formatted message as the `message` property of the\n     * `CombinedGraphQLErrors` object. Follow the [\"Providing a custom message\n     * formatter\"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.\n     *\n     * @param errors - The array of GraphQL errors returned from the server in\n     * the `errors` field of the response.\n     * @param options - Additional context that could be useful when formatting\n     * the message.\n     */\n    function formatMessage(\n      errors: ReadonlyArray<GraphQLFormattedError>,\n      options: MessageFormatterOptions\n    ): string;\n\n    interface InstanceProperties {\n      /**\n       * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.\n       */\n      readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n      /**\n       * Partial data returned in the `data` field of the GraphQL response.\n       */\n      readonly data: Record<string, unknown> | null | undefined;\n\n      /**\n       * Extensions returned by the `extensions` field in the GraphQL response.\n       */\n      readonly extensions: Record<string, unknown> | undefined;\n    }\n\n    /**\n     * A method that determines whether an error is a `{{errorClass}}`\n     * object. This method enables TypeScript to narrow the error type.\n     *\n     * @example\n     *\n     * ```ts\n     * if ({{errorClass}}.is(error)) {\n     *   // TypeScript now knows `error` is a `{{errorClass}}` object\n     *   console.log(error.errors);\n     * }\n     * ```\n     */\n    function is(error: unknown): boolean;\n  }\n}\n\nfunction defaultFormatMessage(errors: ReadonlyArray<GraphQLFormattedError>) {\n  return (\n    errors\n      // Handle non-spec-compliant servers: See #1185\n      .filter((e) => e)\n      .map((e) => e.message || \"Error message not found.\")\n      .join(\"\\n\")\n  );\n}\n\n/**\n * Represents the combined list of GraphQL errors returned from the server in a\n * GraphQL response. This error type is used when your GraphQL operation returns\n * errors in the `errors` field of the response.\n *\n * @remarks\n *\n * When your GraphQL operation encounters errors on the server side (such as\n * resolver errors, validation errors, or syntax errors), the server returns\n * these errors in the `errors` array of the GraphQL response. Apollo Client\n * wraps these errors in a `CombinedGraphQLErrors` object, which provides access\n * to the individual errors while maintaining additional context about the\n * response.\n *\n * @example\n *\n * ```ts\n * import { CombinedGraphQLErrors } from \"@apollo/client/errors\";\n *\n * // Check if an error is a CombinedGraphQLErrors object\n * if (CombinedGraphQLErrors.is(error)) {\n *   // Access individual GraphQL errors\n *   error.errors.forEach((graphQLError) => {\n *     console.log(graphQLError.message);\n *     console.log(graphQLError.path);\n *     console.log(graphQLError.locations);\n *   });\n *\n *   // Access the original GraphQL result\n *   console.log(error.result);\n * }\n * ```\n */\nexport class CombinedGraphQLErrors extends Error {\n  /**\n   * {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.is:function(1) {\"errorClass\":\"CombinedGraphQLErrors\"}}\n   */\n  static is(error: unknown): error is CombinedGraphQLErrors {\n    return isBranded(error, \"CombinedGraphQLErrors\");\n  }\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.formatMessage:function(1)} */\n  static formatMessage: CombinedGraphQLErrors.MessageFormatter =\n    defaultFormatMessage;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#errors:member} */\n  readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#data:member} */\n  readonly data: Record<string, unknown> | null | undefined;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#extensions:member} */\n  readonly extensions: Record<string, unknown> | undefined;\n\n  constructor(result: FormattedExecutionResult<any>);\n  constructor(\n    result: ApolloLink.Result<any>,\n    errors: ReadonlyArray<GraphQLFormattedError>\n  );\n\n  constructor(\n    result: ApolloLink.Result<any> | FormattedExecutionResult<any>,\n    errors = (result as FormattedExecutionResult<any>).errors || []\n  ) {\n    super(\n      CombinedGraphQLErrors.formatMessage(errors, {\n        result,\n        defaultFormatMessage,\n      })\n    );\n    this.errors = errors;\n    this.data = (result as Partial<FormattedExecutionResult>).data;\n    this.extensions = (result as Partial<FormattedExecutionResult>).extensions;\n    this.name = \"CombinedGraphQLErrors\";\n\n    brand(this);\n    Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);\n  }\n}\n"],"names":[],"mappings":"AAIA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AA8H7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAA0E,EAA1E;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CACL,CADJ,CAAA,CAAA,CAAA,CAAA;QAEM,CAAN,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACA,CAAO,CAAP,CAAA,CAAA,CAAA,CAAA,CAAa,CAAC,CAAC,CAAC,EAAE,CAAlB,EAAqB,CAAC;QACtB,CAAO,CAAP,CAAA,CAAU,CAAC,CAAC,CAAC,EAAE,CAAf,EAAkB,CAAC,CAAC,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD;QACzD,CAAO,CAAP,CAAA,CAAA,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAgB,CAAC,CACd;AACH;AAEA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA2C,CAA3C,CAAA,CAAA,CAAA,EAAA;;;;;;;;;;;;;;IAIE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmD,CAAC;IAClD;;;;;;;;;;;;;;;;;IAGA,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACwB;;;;IAGb,CAAX,CAAA,CAAA,CAAA,CAAA,CAAiB;;;;IAGN,CAAX,CAAA,CAAA,CAAe;;;;IAGJ,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;IAQnB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CACkE,EAC9D,CAFJ,CAAA,CAAA,CAAA,CAAA,EAAA,EAEc,CAFd,CAAA,CAAA,CAAA,CAAA,CAEsD,CAAC,CAFvD,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAEiE,CAFjE,CAEmE,EAFnE;QAII,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC2B,CAAC,CAD5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACyC,CAAC,CAD1C,CAAA,CAAA,CAAA,CAAA,CACgD,EAAE;YAC1C,CAAR,CAAA,CAAA,CAAA,CAAA,CAAc;YACN,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QAC5B,CAAO,CAAC,CACH;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB;QACpB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAiB,CAAjB,CAAA,CAAA,CAAA,CAAA,CAA6D,CAAC,CAA9D,CAAA,CAAA,CAAkE;QAC9D,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAmE,CAAC,CAApE,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8E;QAC1E,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC;QAEnC,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC,CAAtD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC;IAC9D;;"}

package/errors/CombinedProtocolErrors.d.ts

@@ -1,20 +1,150 @@
 import type { GraphQLFormattedError } from "graphql";
 export declare namespace CombinedProtocolErrors {
     interface MessageFormatterOptions {
+        /**
+         * 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.
+         *
+         * ```ts
+         * CombinedProtocolErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+         *   return `[Protocol errors]: ${defaultFormatMessage(errors)}`;
+         * };
+         * ```
+         */
         defaultFormatMessage: (errors: ReadonlyArray<GraphQLFormattedError>) => string;
     }
+    /**
+     * By default, `CombinedProtocolErrors` formats the `message` property by
+     * joining each error's `message` field with a newline. To customize the
+     * format of the `message`, such as changing the delimiter or adding a message
+     * prefix, override the static `formatMessage` method.
+     *
+     * @remarks
+     *
+     * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors) section for details about the parameters provided to the `formatMessage` function.
+     *
+     * > [!NOTE]
+     * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.
+     *
+     * @example
+     *
+     * The following example demonstrates how to format the error message by
+     * joining each error with a comma.
+     *
+     * ```ts
+     * import { CombinedProtocolErrors } from "@apollo/client/errors";
+     *
+     * CombinedProtocolErrors.formatMessage = (errors) => {
+     *   return errors.map((error) => error.message).join(", ");
+     * };
+     * ```
+     *
+     * @param errors - The array of GraphQL errors returned from the server in the
+     * `errors` field of the response.
+     * @param options - Additional context that could be useful when formatting
+     * the message.
+     */
     type MessageFormatter = (errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions) => string;
+    namespace DocumentationTypes {
+        /**
+         * A function that formats the error message used for the error's `message`
+         * property. Override this method to provide your own formatting.
+         *
+         * @remarks
+         *
+         * The `formatMessage` function is called by the `CombinedProtocolErrors`
+         * constructor to provide a formatted message as the `message` property of the
+         * `CombinedProtocolErrors` object. Follow the ["Providing a custom message
+         * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+         *
+         * @param errors - The array of GraphQL errors returned from the server in the
+         * `errors` field of the response.
+         * @param options - Additional context that could be useful when formatting
+         * the message.
+         */
+        function formatMessage(errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions): string;
+        interface InstanceProperties {
+            /**
+             * The raw list of errors returned by the top-level `errors` field in the
+             * multipart HTTP subscription response.
+             */
+            readonly errors: ReadonlyArray<GraphQLFormattedError>;
+        }
+    }
 }
 /**
  * Fatal transport-level errors returned when executing a subscription using the
  * multipart HTTP subscription protocol. See the documentation on the
  * [multipart HTTP protocol for GraphQL Subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol) for more information on these errors.
+ *
+ * @remarks
+ *
+ * These errors indicate issues with the subscription transport itself, rather
+ * than GraphQL-level errors. They typically occur when there are problems
+ * communicating with subgraphs from the Apollo Router.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedProtocolErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedProtocolErrors instance
+ * if (CombinedProtocolErrors.is(error)) {
+ *   // Access individual protocol errors
+ *   error.errors.forEach((protocolError) => {
+ *     console.log(protocolError.message);
+ *     console.log(protocolError.extensions);
+ *   });
+ * }
+ * ```
  */
 export declare class CombinedProtocolErrors extends Error {
-    /** Determine if an error is a `CombinedProtocolErrors` instance */
+    /**
+     * A method that determines whether an error is a `CombinedProtocolErrors`
+     * object. This method enables TypeScript to narrow the error type.
+     *
+     * @example
+     *
+     * ```ts
+     * if (CombinedProtocolErrors.is(error)) {
+     *   // TypeScript now knows `error` is a CombinedProtocolErrors object
+     *   console.log(error.errors);
+     * }
+     * ```
+     */
     static is(error: unknown): error is CombinedProtocolErrors;
+    /**
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedProtocolErrors`
+    * constructor to provide a formatted message as the `message` property of the
+    * `CombinedProtocolErrors` object. Follow the ["Providing a custom message
+    * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in the
+    * `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
     static formatMessage: CombinedProtocolErrors.MessageFormatter;
-    errors: ReadonlyArray<GraphQLFormattedError>;
+    /**
+    * The raw list of errors returned by the top-level `errors` field in the
+    * multipart HTTP subscription response.
+    */
+    readonly errors: ReadonlyArray<GraphQLFormattedError>;
     constructor(protocolErrors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>);
 }
 //# sourceMappingURL=CombinedProtocolErrors.d.ts.map

package/errors/CombinedProtocolErrors.js

@@ -6,13 +6,66 @@ function defaultFormatMessage(errors) {
  * Fatal transport-level errors returned when executing a subscription using the
  * multipart HTTP subscription protocol. See the documentation on the
  * [multipart HTTP protocol for GraphQL Subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol) for more information on these errors.
+ *
+ * @remarks
+ *
+ * These errors indicate issues with the subscription transport itself, rather
+ * than GraphQL-level errors. They typically occur when there are problems
+ * communicating with subgraphs from the Apollo Router.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedProtocolErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedProtocolErrors instance
+ * if (CombinedProtocolErrors.is(error)) {
+ *   // Access individual protocol errors
+ *   error.errors.forEach((protocolError) => {
+ *     console.log(protocolError.message);
+ *     console.log(protocolError.extensions);
+ *   });
+ * }
+ * ```
  */
 export class CombinedProtocolErrors extends Error {
-    /** Determine if an error is a `CombinedProtocolErrors` instance */
+    /**
+     * A method that determines whether an error is a `CombinedProtocolErrors`
+     * object. This method enables TypeScript to narrow the error type.
+     *
+     * @example
+     *
+     * ```ts
+     * if (CombinedProtocolErrors.is(error)) {
+     *   // TypeScript now knows `error` is a CombinedProtocolErrors object
+     *   console.log(error.errors);
+     * }
+     * ```
+     */
     static is(error) {
         return isBranded(error, "CombinedProtocolErrors");
     }
+    /**
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedProtocolErrors`
+    * constructor to provide a formatted message as the `message` property of the
+    * `CombinedProtocolErrors` object. Follow the ["Providing a custom message
+    * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in the
+    * `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
     static formatMessage = defaultFormatMessage;
+    /**
+    * The raw list of errors returned by the top-level `errors` field in the
+    * multipart HTTP subscription response.
+    */
     errors;
     constructor(protocolErrors) {
         super(CombinedProtocolErrors.formatMessage(protocolErrors, {

package/errors/CombinedProtocolErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"CombinedProtocolErrors.js","sources":["../../src/errors/CombinedProtocolErrors.ts"],"sourcesContent":["import type { GraphQLFormattedError } from \"graphql\";\n\nimport { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace CombinedProtocolErrors {\n  export interface MessageFormatterOptions {\n    defaultFormatMessage: (\n      errors: ReadonlyArray<GraphQLFormattedError>\n    ) => string;\n  }\n\n  export type MessageFormatter = (\n    errors: ReadonlyArray<GraphQLFormattedError>,\n    options: MessageFormatterOptions\n  ) => string;\n}\n\nfunction defaultFormatMessage(errors: ReadonlyArray<GraphQLFormattedError>) {\n  return errors.map((e) => e.message || \"Error message not found.\").join(\"\\n\");\n}\n\n/**\n * Fatal transport-level errors returned when executing a subscription using the\n * multipart HTTP subscription protocol. See the documentation on the\n * [multipart HTTP protocol for GraphQL Subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol) for more information on these errors.\n */\nexport class CombinedProtocolErrors extends Error {\n  /** Determine if an error is a `CombinedProtocolErrors` instance */\n  static is(error: unknown): error is CombinedProtocolErrors {\n    return isBranded(error, \"CombinedProtocolErrors\");\n  }\n\n  static formatMessage: CombinedProtocolErrors.MessageFormatter =\n    defaultFormatMessage;\n\n  errors: ReadonlyArray<GraphQLFormattedError>;\n\n  constructor(\n    protocolErrors:\n      | Array<GraphQLFormattedError>\n      | ReadonlyArray<GraphQLFormattedError>\n  ) {\n    super(\n      CombinedProtocolErrors.formatMessage(protocolErrors, {\n        defaultFormatMessage,\n      })\n    );\n    this.name = \"CombinedProtocolErrors\";\n    this.errors = protocolErrors;\n\n    brand(this);\n    Object.setPrototypeOf(this, CombinedProtocolErrors.prototype);\n  }\n}\n"],"names":[],"mappings":"AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AAe7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAA0E,EAA1E;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe,CAAC,CAAhB,CAAA,CAAmB,CAAC,CAAC,CAAC,EAAE,CAAxB,EAA2B,CAAC,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAwC,CAAxC,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkE,CAAC,CAAC,CAApE,CAAA,CAAA,CAAwE,CAAC,CAAzE,CAAA,CAAA,CAA6E,CAAC;AAC9E;AAEA,CAAA,CAAA;;;;CAIA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA4C,CAA5C,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD,CAAC;IACnD;IAEA,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACwB;IAEtB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAQ;IAEN,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAG4C,EAH5C;QAKI,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC4B,CAAC,CAD7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC0C,CAAC,CAD3C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACyD,EAAE;YACnD,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QAC5B,CAAO,CAAC,CACH;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwC;QACpC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC;QAE5B,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,CAAC,CAAvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgE,CAAC;IAC/D;;"}
+{"version":3,"file":"CombinedProtocolErrors.js","sources":["../../src/errors/CombinedProtocolErrors.ts"],"sourcesContent":["import type { GraphQLFormattedError } from \"graphql\";\n\nimport { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace CombinedProtocolErrors {\n  export interface MessageFormatterOptions {\n    /**\n     * The default message formatter. Call this to get a string with the default\n     * formatted message.\n     *\n     * @remarks\n     * To format part of the message using the default message formatter, call\n     * the `defaultFormatMessage` function provided to the `options` argument of\n     * your message formatter.\n     *\n     * @example\n     *\n     * The following example prepends a string to the message and uses the\n     * default message formatter to format the error messages.\n     *\n     * ```ts\n     * CombinedProtocolErrors.formatMessage = (errors, { defaultFormatMessage }) => {\n     *   return `[Protocol errors]: ${defaultFormatMessage(errors)}`;\n     * };\n     * ```\n     */\n    defaultFormatMessage: (\n      errors: ReadonlyArray<GraphQLFormattedError>\n    ) => string;\n  }\n\n  /**\n   * By default, `CombinedProtocolErrors` formats the `message` property by\n   * joining each error's `message` field with a newline. To customize the\n   * format of the `message`, such as changing the delimiter or adding a message\n   * prefix, override the static `formatMessage` method.\n   *\n   * @remarks\n   *\n   * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors) section for details about the parameters provided to the `formatMessage` function.\n   *\n   * > [!NOTE]\n   * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.\n   *\n   * @example\n   *\n   * The following example demonstrates how to format the error message by\n   * joining each error with a comma.\n   *\n   * ```ts\n   * import { CombinedProtocolErrors } from \"@apollo/client/errors\";\n   *\n   * CombinedProtocolErrors.formatMessage = (errors) => {\n   *   return errors.map((error) => error.message).join(\", \");\n   * };\n   * ```\n   *\n   * @param errors - The array of GraphQL errors returned from the server in the\n   * `errors` field of the response.\n   * @param options - Additional context that could be useful when formatting\n   * the message.\n   */\n  export type MessageFormatter = (\n    errors: ReadonlyArray<GraphQLFormattedError>,\n    options: MessageFormatterOptions\n  ) => string;\n\n  namespace DocumentationTypes {\n    /**\n     * A function that formats the error message used for the error's `message`\n     * property. Override this method to provide your own formatting.\n     *\n     * @remarks\n     *\n     * The `formatMessage` function is called by the `CombinedProtocolErrors`\n     * constructor to provide a formatted message as the `message` property of the\n     * `CombinedProtocolErrors` object. Follow the [\"Providing a custom message\n     * formatter\"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.\n     *\n     * @param errors - The array of GraphQL errors returned from the server in the\n     * `errors` field of the response.\n     * @param options - Additional context that could be useful when formatting\n     * the message.\n     */\n    function formatMessage(\n      errors: ReadonlyArray<GraphQLFormattedError>,\n      options: MessageFormatterOptions\n    ): string;\n\n    interface InstanceProperties {\n      /**\n       * The raw list of errors returned by the top-level `errors` field in the\n       * multipart HTTP subscription response.\n       */\n      readonly errors: ReadonlyArray<GraphQLFormattedError>;\n    }\n  }\n}\n\nfunction defaultFormatMessage(errors: ReadonlyArray<GraphQLFormattedError>) {\n  return errors.map((e) => e.message || \"Error message not found.\").join(\"\\n\");\n}\n\n/**\n * Fatal transport-level errors returned when executing a subscription using the\n * multipart HTTP subscription protocol. See the documentation on the\n * [multipart HTTP protocol for GraphQL Subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol) for more information on these errors.\n *\n * @remarks\n *\n * These errors indicate issues with the subscription transport itself, rather\n * than GraphQL-level errors. They typically occur when there are problems\n * communicating with subgraphs from the Apollo Router.\n *\n * @example\n *\n * ```ts\n * import { CombinedProtocolErrors } from \"@apollo/client/errors\";\n *\n * // Check if an error is a CombinedProtocolErrors instance\n * if (CombinedProtocolErrors.is(error)) {\n *   // Access individual protocol errors\n *   error.errors.forEach((protocolError) => {\n *     console.log(protocolError.message);\n *     console.log(protocolError.extensions);\n *   });\n * }\n * ```\n */\nexport class CombinedProtocolErrors extends Error {\n  /**\n   * A method that determines whether an error is a `CombinedProtocolErrors`\n   * object. This method enables TypeScript to narrow the error type.\n   *\n   * @example\n   *\n   * ```ts\n   * if (CombinedProtocolErrors.is(error)) {\n   *   // TypeScript now knows `error` is a CombinedProtocolErrors object\n   *   console.log(error.errors);\n   * }\n   * ```\n   */\n  static is(error: unknown): error is CombinedProtocolErrors {\n    return isBranded(error, \"CombinedProtocolErrors\");\n  }\n\n  /** {@inheritDoc @apollo/client!CombinedProtocolErrors.DocumentationTypes.formatMessage:function(1)} */\n  static formatMessage: CombinedProtocolErrors.MessageFormatter =\n    defaultFormatMessage;\n\n  /** {@inheritDoc @apollo/client!CombinedProtocolErrors.DocumentationTypes.InstanceProperties#errors:member} */\n  readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n  constructor(\n    protocolErrors:\n      | Array<GraphQLFormattedError>\n      | ReadonlyArray<GraphQLFormattedError>\n  ) {\n    super(\n      CombinedProtocolErrors.formatMessage(protocolErrors, {\n        defaultFormatMessage,\n      })\n    );\n    this.name = \"CombinedProtocolErrors\";\n    this.errors = protocolErrors;\n\n    brand(this);\n    Object.setPrototypeOf(this, CombinedProtocolErrors.prototype);\n  }\n}\n"],"names":[],"mappings":"AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AAiG7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAA0E,EAA1E;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe,CAAC,CAAhB,CAAA,CAAmB,CAAC,CAAC,CAAC,EAAE,CAAxB,EAA2B,CAAC,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAwC,CAAxC,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkE,CAAC,CAAC,CAApE,CAAA,CAAA,CAAwE,CAAC,CAAzE,CAAA,CAAA,CAA6E,CAAC;AAC9E;AAEA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;CAyBA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA4C,CAA5C,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA;;;;;;;;;;;;KAYA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD,CAAC;IACnD;;;;;;;;;;;;;;;;;IAGA,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACwB;;;;;IAGb,CAAX,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAG4C,EAH5C;QAKI,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC4B,CAAC,CAD7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC0C,CAAC,CAD3C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACyD,EAAE;YACnD,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QAC5B,CAAO,CAAC,CACH;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwC;QACpC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC;QAE5B,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,CAAC,CAAvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgE,CAAC;IAC/D;;"}

package/errors/LinkError.d.ts

@@ -7,11 +7,54 @@ import type { ErrorLike } from "@apollo/client";
 export declare function registerLinkError(error: ErrorLike): void;
 /**
  * A facade error type that keeps a registry of errors emitted from the link
- * chain. Determine if an error is from the link chain using `NetworkError.is`.
+ * chain. `LinkError` is not an error class itself but rather a utility to
+ * detect whether an error originated from the link chain.
+ *
+ * @remarks
+ *
+ * Use `LinkError` to distinguish between errors from the link chain and custom
+ * errors. This is helpful for retrying an operation at the call site only when
+ * the error originates from the link chain.
+ *
+ * @example
+ *
+ * The following example creates a custom wrapped query function that detects
+ * whether the query includes an operation name and throws if not.
+ *
+ * ```ts
+ * import { LinkError } from "@apollo/client/errors";
+ *
+ * async function runQuery<TData>(query: TypedDocumentNode<TData>) {
+ *   if (!hasOperationName(query)) {
+ *     throw new Error("Queries should have operation names.");
+ *   }
+ *
+ *   return client.watchQuery({ query });
+ * }
+ *
+ * try {
+ *   const result = await runQuery(query);
+ * } catch (error) {
+ *   // Only log the error if the error wasn't our own custom thrown error
+ *   if (LinkError.is(error)) {
+ *     console.log("Got network error:", error.message);
+ *   }
+ * }
+ * ```
  */
 export declare const LinkError: {
     /**
-     * Determine if the error is an error emitted from the link chain.
+     * A method that determines whether an error originated from the link chain.
+     * `is` does not provide any type narrowing.
+     *
+     * @example
+     *
+     * ```ts
+     * if (LinkError.is(error)) {
+     *   // The error originated from the link chain
+     *   console.log("Got network error:", error.message);
+     * }
+     * ```
      */
     is: (error: unknown) => boolean;
 };