@aws-amplify/api-graphql 3.4.12-api-v6-models.b3abc9b.0 → 4.0.0

package/lib/internals/v6.d.ts

@@ -1,4 +1,4 @@
-import { GraphQLOptionsV6, GraphQLResponseV6 } from '../types';
+import { V6Client, GraphQLOptionsV6, GraphQLResponseV6 } from '../types';
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
  * output types if Amplify-generated graphql from a recent version of the CLI/codegen
@@ -83,7 +83,19 @@ import { GraphQLOptionsV6, GraphQLResponseV6 } from '../types';
  * @param options
  * @param additionalHeaders
  */
-export declare function graphql<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
+export declare function graphql<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(this: V6Client, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
     [key: string]: string;
 }): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+/**
+ * Cancels an inflight request. Only applicable for graphql queries and mutations
+ * @param {any} request - request to cancel
+ * @returns - A boolean indicating if the request was cancelled
+ */
+export declare function cancel(this: V6Client, promise: Promise<any>, message?: string): boolean;
+/**
+ * Checks to see if an error thrown is from an api request cancellation
+ * @param {any} error - Any error
+ * @returns - A boolean indicating if the error was from an api request cancellation
+ */
+export declare function isCancelError(this: V6Client, error: any): boolean;
 export { GraphQLOptionsV6, GraphQLResponseV6 };

package/lib/internals/v6.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var GraphQLAPI_1 = require("../GraphQLAPI");
+const GraphQLAPI_1 = require("../GraphQLAPI");
+const types_1 = require("../types");
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
  * output types if Amplify-generated graphql from a recent version of the CLI/codegen
@@ -93,8 +94,25 @@ function graphql(options, additionalHeaders) {
      * Neither of these can actually be validated at runtime. Hence, we don't perform
      * any validation or type-guarding here.
      */
-    var result = GraphQLAPI_1.GraphQLAPI.graphql(options, additionalHeaders);
+    const result = GraphQLAPI_1.GraphQLAPI.graphql(this[types_1.__amplify], options, additionalHeaders);
     return result;
 }
 exports.graphql = graphql;
-//# sourceMappingURL=v6.js.map
+/**
+ * Cancels an inflight request. Only applicable for graphql queries and mutations
+ * @param {any} request - request to cancel
+ * @returns - A boolean indicating if the request was cancelled
+ */
+function cancel(promise, message) {
+    return GraphQLAPI_1.GraphQLAPI.cancel(promise, message);
+}
+exports.cancel = cancel;
+/**
+ * Checks to see if an error thrown is from an api request cancellation
+ * @param {any} error - Any error
+ * @returns - A boolean indicating if the error was from an api request cancellation
+ */
+function isCancelError(error) {
+    return GraphQLAPI_1.GraphQLAPI.isCancelError(error);
+}
+exports.isCancelError = isCancelError;