@graphql-tools/executor-http - npm Package Compare versions

Comparing version 1.2.0-alpha-753096403f92c5dbcdd17828acdd17a1aa53a51e to 1.2.0-alpha-86e733ffb08895d626b8ea51c0bcdae30f3cdd7e

CHANGELOG.md

 # @graphql-tools/executor-http
 
-## 1.2.0-alpha-753096403f92c5dbcdd17828acdd17a1aa53a51e
+## 1.2.0-alpha-86e733ffb08895d626b8ea51c0bcdae30f3cdd7e
 
 ### Minor Changes
 
-- [#313](https://github.com/graphql-hive/gateway/pull/313) [`7530964`](https://github.com/graphql-hive/gateway/commit/753096403f92c5dbcdd17828acdd17a1aa53a51e) Thanks [@ardatan](https://github.com/ardatan)! - Automatic Persisted Queries support for upstream requests
+- [#313](https://github.com/graphql-hive/gateway/pull/313) [`9f40491`](https://github.com/graphql-hive/gateway/commit/9f404916e31495526e7ca3df476e884ff986d6ff) Thanks [@ardatan](https://github.com/ardatan)! - Automatic Persisted Queries support for upstream requests
 
@@ -9,0 +9,0 @@ For HTTP Executor;

dist/index.d.ts

@@ -17,6 +17,16 @@ import { ExecutionRequest, DisposableSyncExecutor, DisposableAsyncExecutor } from '@graphql-tools/utils';
 interface HTTPExecutorOptions {
+    /**
+     * The endpoint to use when querying the upstream API
+     * @default '/graphql'
+     */
     endpoint?: string;
+    /**
+     * The WHATWG compatible fetch implementation to use
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+     * @default globalThis.fetch
+     */
     fetch?: FetchFn;
     /**
      * Whether to use the GET HTTP method for queries when querying the original schema
+     * @default false
      */
@@ -29,3 +39,4 @@ useGETForQueries?: boolean;
     /**
-     * HTTP method to use when querying the original schema.
+     * HTTP method to use when querying the original schema.x
+     * @default 'POST'
      */
@@ -38,3 +49,4 @@ method?: 'GET' | 'POST';
     /**
-     * Request Credentials (default: 'same-origin')
+     * Request Credentials
+     * @default 'same-origin'
      * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
@@ -48,3 +60,3 @@ */
     /**
-     * WHATWG compatible File implementation
+     * WHATWG compatible `File` implementation
      * @see https://developer.mozilla.org/en-US/docs/Web/API/File
@@ -54,3 +66,3 @@ */
     /**
-     * WHATWG compatible FormData implementation
+     * WHATWG compatible `FormData` implementation
      * @see https://developer.mozilla.org/en-US/docs/Web/API/FormData
@@ -60,8 +72,14 @@ */
     /**
-     * Print function for DocumentNode
+     * Print function for `DocumentNode`
+     * Useful when you want to memoize the print function or use a different implementation to minify the query etc.
      */
     print?: (doc: DocumentNode) => string;
+    /**
+     * Enable Automatic Persisted Queries
+     * @see https://www.apollographql.com/docs/apollo-server/performance/apq/
+     */
     apq?: boolean;
     /**
-     * Enable [Explicit Resource Management](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#using-declarations-and-explicit-resource-management)
+     * Enable Explicit Resource Management
+     * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#using-declarations-and-explicit-resource-management
      * @deprecated The executors are always disposable, and this option will be removed in the next major version, there is no need to have a flag for this.
@@ -68,0 +86,0 @@ */

package.json

 {
   "name": "@graphql-tools/executor-http",
-  "version": "1.2.0-alpha-753096403f92c5dbcdd17828acdd17a1aa53a51e",
+  "version": "1.2.0-alpha-86e733ffb08895d626b8ea51c0bcdae30f3cdd7e",
   "type": "module",
@@ -5,0 +5,0 @@ "description": "A set of utils for faster development of GraphQL tools",

No alert changes

Improved metrics

Total package byte prevSize

70118

increased by1.73%

Lines of code

1310

increased by1.39%

No dependency changes