@aws-amplify/api 4.0.33-unstable.7 → 4.0.33

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.33](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/api@4.0.32...@aws-amplify/api@4.0.33) (2022-02-28)
+
+
+### Bug Fixes
+
+* **@aws-amplify/api:** Improve API.graphql return type ([#9197](https://github.com/aws-amplify/amplify-js/issues/9197)) ([9a0531b](https://github.com/aws-amplify/amplify-js/commit/9a0531b11e9eb6659d36ca0c51c642b3d947f63c))
+
+
+
+
+
 ## [4.0.32](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/api@4.0.31...@aws-amplify/api@4.0.32) (2022-02-03)
 
 **Note:** Version bump only for package @aws-amplify/api

package/dist/aws-amplify-api.js

@@ -9889,9 +9889,9 @@ function () {
   /**
    * Executes a GraphQL operation
    *
-   * @param {GraphQLOptions} GraphQL Options
-   * @param {object} additionalHeaders headers to merge in after any `graphql_headers` set in the config
-   * @returns {Promise<GraphQLResult> | Observable<object>}
+   * @param options - GraphQL Options
+   * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
+   * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
    */
 
 
@@ -9941,9 +9941,10 @@ function () {
           variables: variables,
           authMode: authMode
         }, headers);
-    }
 
-    throw new Error("invalid operation type: " + operationType);
+      default:
+        throw new Error("invalid operation type: " + operationType);
+    }
   };
 
   GraphQLAPIClass.prototype._graphql = function (_a, additionalHeaders, initParams) {
@@ -15198,10 +15199,10 @@ function () {
   };
   /**
    * Make a GET request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15210,10 +15211,10 @@ function () {
   };
   /**
    * Make a POST request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15222,10 +15223,10 @@ function () {
   };
   /**
    * Make a PUT request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15234,10 +15235,10 @@ function () {
   };
   /**
    * Make a PATCH request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15246,10 +15247,10 @@ function () {
   };
   /**
    * Make a DEL request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15258,10 +15259,10 @@ function () {
   };
   /**
    * Make a HEAD request
-   * @param {string} apiName - The api name of the request
-   * @param {string} path - The path of the request
-   * @param {json} [init] - Request extra params
-   * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+   * @param apiName - The api name of the request
+   * @param path - The path of the request
+   * @param [init] - Request extra params
+   * @return A promise that resolves to an object with response status and JSON data, if successful.
    */
 
 
@@ -15270,8 +15271,8 @@ function () {
   };
   /**
    * Checks to see if an error thrown is from an api request cancellation
-   * @param {any} error - Any error
-   * @return {boolean} - A boolean indicating if the error was from an api request cancellation
+   * @param error - Any error
+   * @return If the error was from an api request cancellation
    */
 
 
@@ -15280,8 +15281,9 @@ function () {
   };
   /**
    * Cancels an inflight request
-   * @param {any} request - request to cancel
-   * @return {boolean} - A boolean indicating if the request was cancelled
+   * @param request - request to cancel
+   * @param [message] - custom error message
+   * @return If the request was cancelled
    */
 
 
@@ -15290,8 +15292,8 @@ function () {
   };
   /**
    * Getting endpoint for API
-   * @param {string} apiName - The name of the api
-   * @return {string} - The endpoint of the api
+   * @param apiName - The name of the api
+   * @return The endpoint of the api
    */
 
 
@@ -15313,14 +15315,6 @@ function () {
   APIClass.prototype.getGraphqlOperationType = function (operation) {
     return this._graphqlApi.getGraphqlOperationType(operation);
   };
-  /**
-   * Executes a GraphQL operation
-   *
-   * @param {GraphQLOptions} GraphQL Options
-   * @param {object} additionalHeaders headers to merge in after any `graphql_headers` set in the config
-   * @returns {Promise<GraphQLResult> | Observable<object>}
-   */
-
 
   APIClass.prototype.graphql = function (options, additionalHeaders) {
     return this._graphqlApi.graphql(options, additionalHeaders);