Interface: LoadFromUrlOptions

Defined in: packages/loaders/url/src/index.ts:66

Additional options for loading from a URL

Extends

BaseLoaderOptions.Partial<IntrospectionOptions>.HTTPExecutorOptions

Properties

allowLegacySDLEmptyFields?

optional allowLegacySDLEmptyFields?: boolean

Defined in: packages/utils/src/Interfaces.ts:109

Inherited from

BaseLoaderOptions.allowLegacySDLEmptyFields

allowLegacySDLImplementsInterfaces?

optional allowLegacySDLImplementsInterfaces?: boolean

Defined in: packages/utils/src/Interfaces.ts:110

Inherited from

BaseLoaderOptions.allowLegacySDLImplementsInterfaces

apq?

optional apq?: boolean

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:77

Enable Automatic Persisted Queries

See

https://www.apollographql.com/docs/apollo-server/performance/apq/

Inherited from

HTTPExecutorOptions.apq

assumeValid?

optional assumeValid?: boolean

Defined in: node_modules/graphql/type/schema.d.ts:146

When building a schema from a GraphQL service’s introspection result, it might be safe to assume the schema is valid. Set to true to assume the produced schema is valid.

Default: false

Inherited from

BaseLoaderOptions.assumeValid

assumeValidSDL?

optional assumeValidSDL?: boolean

Defined in: node_modules/graphql/utilities/buildASTSchema.d.ts:12

Set to true to assume the SDL is valid.

Default: false

Inherited from

BaseLoaderOptions.assumeValidSDL

batch?

optional batch?: boolean

Defined in: packages/loaders/url/src/index.ts:101

Enable Batching

commentDescriptions?

optional commentDescriptions?: boolean

Defined in: packages/utils/src/Interfaces.ts:117

Set to true in order to convert all GraphQL comments (marked with # sign) to descriptions (""") GraphQL has built-in support for transforming descriptions to comments (with print), but not while parsing. Turning the flag on will support the other way as well (parse)

Inherited from

BaseLoaderOptions.commentDescriptions

connectionParams?

optional connectionParams?: Record<string, unknown> | (() => Record<string, unknown>)

Defined in: packages/loaders/url/src/index.ts:97

Connection Parameters for WebSockets connection

credentials?

optional credentials?: RequestCredentials

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:53

Request Credentials

Default


'same-origin'

See

https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials

Inherited from

HTTPExecutorOptions.credentials

customFetch?

optional customFetch?: string | FetchFn

Defined in: packages/loaders/url/src/index.ts:72

A custom fetch implementation to use when querying the original schema. Defaults to cross-fetch

cwd?

optional cwd?: string

Defined in: packages/utils/src/loaders.ts:13

Inherited from

BaseLoaderOptions.cwd

deduplicateInflightRequests?

optional deduplicateInflightRequests?: boolean

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:94

Whether to deduplicate inflight requests with the same parameters. This can be useful to avoid making multiple identical requests to the upstream service when multiple parts of the gateway are requesting the same data at the same time.

Default


true

Inherited from

HTTPExecutorOptions.deduplicateInflightRequests

descriptions?

optional descriptions?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:8

Whether to include descriptions in the introspection result. Default: true

Inherited from

Partial.descriptions

directiveIsRepeatable?

optional directiveIsRepeatable?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:18

Whether to include isRepeatable flag on directives. Default: false

Inherited from

Partial.directiveIsRepeatable

disposable?

optional disposable?: boolean

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:83

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.

Inherited from

HTTPExecutorOptions.disposable

endpoint?

optional endpoint?: string

Defined in: packages/loaders/url/src/index.ts:85

Regular HTTP endpoint; defaults to the pointer

Overrides

HTTPExecutorOptions.endpoint

experimentalFragmentVariables?

optional experimentalFragmentVariables?: boolean

Defined in: packages/utils/src/Interfaces.ts:111

Inherited from

BaseLoaderOptions.experimentalFragmentVariables

exposeHTTPDetailsInExtensions?

optional exposeHTTPDetailsInExtensions?: boolean

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:102

This option allows you to include the response detauls in the result extensions when a request fails. This can be useful for debugging and error handling purposes, as it provides additional context about the response that led to the error. However, be cautious when enabling this option, as response headers may contain sensitive information.

Default


false

Inherited from

HTTPExecutorOptions.exposeHTTPDetailsInExtensions

fetch?

optional fetch?: FetchFn

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:29

The WHATWG compatible fetch implementation to use

See

https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

Default


globalThis.fetch

Inherited from

HTTPExecutorOptions.fetch

File?

optional File?: {(fileBits, fileName, options?): File; prototype: File; }

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:62

WHATWG compatible File implementation

Parameters

fileBits

BlobPart[]

fileName

string

options?

FilePropertyBag

Returns

File

prototype

prototype: File

See

https://developer.mozilla.org/en-US/docs/Web/API/File

Inherited from

HTTPExecutorOptions.File

FormData?

optional FormData?: {(form?, submitter?): FormData; prototype: FormData; }

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:67

WHATWG compatible FormData implementation

Parameters

form?

HTMLFormElement

submitter?

HTMLElement | null

Returns

FormData

prototype

prototype: FormData

See

https://developer.mozilla.org/en-US/docs/Web/API/FormData

Inherited from

HTTPExecutorOptions.FormData

handleAsSDL?

optional handleAsSDL?: boolean

Defined in: packages/loaders/url/src/index.ts:81

Handle URL as schema SDL

headers?

optional headers?: HeadersConfig | ((executorRequest?) => HeadersConfig)

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:38

Additional headers to include when querying the original schema

Inherited from

HTTPExecutorOptions.headers

ignore?

optional ignore?: string | string[]

Defined in: packages/utils/src/loaders.ts:14

Inherited from

BaseLoaderOptions.ignore

includeSources?

optional includeSources?: boolean

Defined in: packages/utils/src/loaders.ts:15

Inherited from

BaseLoaderOptions.includeSources

inputValueDeprecation?

optional inputValueDeprecation?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:28

Whether target GraphQL server support deprecation of input values. Default: false

Inherited from

Partial.inputValueDeprecation

method?

optional method?: "GET" | "POST"

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:43

HTTP method to use when querying the original schema.x

Default


'POST'

Inherited from

HTTPExecutorOptions.method

noLocation?

optional noLocation?: boolean

Defined in: packages/utils/src/Interfaces.ts:108

Inherited from

BaseLoaderOptions.noLocation

oneOf?

optional oneOf?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:33

Whether target GraphQL server supports @oneOf input objects. Default: false

Inherited from

Partial.oneOf

print?

optional print?: (doc) => string

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:72

Print function for DocumentNode Useful when you want to memoize the print function or use a different implementation to minify the query etc.

Parameters

doc

DocumentNode

Returns

string

Inherited from

HTTPExecutorOptions.print

retry?

optional retry?: number

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:57

Retry attempts

Inherited from

HTTPExecutorOptions.retry

schemaDescription?

optional schemaDescription?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:23

Whether to include description field on schema. Default: false

Inherited from

Partial.schemaDescription

specifiedByUrl?

optional specifiedByUrl?: boolean

Defined in: node_modules/graphql/utilities/getIntrospectionQuery.d.ts:13

Whether to include specifiedByURL in the introspection result. Default: false

Inherited from

Partial.specifiedByUrl

subscriptionsEndpoint?

optional subscriptionsEndpoint?: string

Defined in: packages/loaders/url/src/index.ts:89

Subscriptions endpoint; defaults to the endpoint given as HTTP endpoint

subscriptionsProtocol?

optional subscriptionsProtocol?: SubscriptionProtocol

Defined in: packages/loaders/url/src/index.ts:93

Use specific protocol for subscriptions

timeout?

optional timeout?: number | ((request) => number | undefined)

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:47

Timeout in milliseconds

Inherited from

HTTPExecutorOptions.timeout

useGETForQueries?

optional useGETForQueries?: boolean

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:34

Whether to use the GET HTTP method for queries when querying the original schema

Default


false

Inherited from

HTTPExecutorOptions.useGETForQueries

webSocketImpl?

optional webSocketImpl?: string | typeof WebSocket

Defined in: packages/loaders/url/src/index.ts:77

Custom WebSocket implementation used by the loaded schema if subscriptions are enabled

Methods

getDisposeReason()?

optional getDisposeReason(): Error | undefined

Defined in: node_modules/@graphql-tools/executor-http/dist/index.d.ts:87

On dispose abort error

Returns

Error | undefined

Inherited from

HTTPExecutorOptions.getDisposeReason