graphql-tools-monorepo / loaders/url/src / LoadFromUrlOptions

Interface: LoadFromUrlOptions

loaders/url/src.LoadFromUrlOptions

Additional options for loading from a URL

Hierarchy

• BaseLoaderOptions

• Partial<IntrospectionOptions>

• HTTPExecutorOptions

  ↳ LoadFromUrlOptions

Table of contents

Properties

• File
• FormData
• allowLegacySDLEmptyFields
• allowLegacySDLImplementsInterfaces
• apq
• assumeValid
• assumeValidSDL
• batch
• commentDescriptions
• connectionParams
• credentials
• customFetch
• cwd
• descriptions
• directiveIsRepeatable
• disposable
• endpoint
• experimentalFragmentVariables
• fetch
• handleAsSDL
• headers
• ignore
• includeSources
• inputValueDeprecation
• method
• noLocation
• oneOf
• print
• retry
• schemaDescription
• serviceName
• specifiedByUrl
• subscriptionsEndpoint
• subscriptionsProtocol
• timeout
• useGETForQueries
• webSocketImpl

Methods

• getDisposeReason

Properties

File

• Optional File: Object

WHATWG compatible File implementation

See

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

Call signature

• new File(fileBits, fileName, options?): File

Parameters

Returns

File

Type declaration

Inherited from

HTTPExecutorOptions.File

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:64

FormData

• Optional FormData: Object

WHATWG compatible FormData implementation

See

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

Call signature

• new FormData(form?, submitter?): FormData

Parameters

Returns

FormData

Type declaration

Inherited from

HTTPExecutorOptions.FormData

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:69

allowLegacySDLEmptyFields

• Optional allowLegacySDLEmptyFields: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLEmptyFields

Defined in

packages/utils/src/Interfaces.ts:100 

allowLegacySDLImplementsInterfaces

• Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLImplementsInterfaces

Defined in

packages/utils/src/Interfaces.ts:101 

apq

• Optional apq: boolean

Enable Automatic Persisted Queries

See

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

Inherited from

HTTPExecutorOptions.apq

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:79

assumeValid

• Optional assumeValid: boolean

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

Defined in

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

assumeValidSDL

• Optional assumeValidSDL: boolean

Set to true to assume the SDL is valid.

Default: false

Inherited from

BaseLoaderOptions.assumeValidSDL

Defined in

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

batch

• Optional batch: boolean

Enable Batching

Defined in

packages/loaders/url/src/index.ts:103 

commentDescriptions

• Optional commentDescriptions: boolean

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

Defined in

packages/utils/src/Interfaces.ts:108 

connectionParams

• Optional connectionParams: Record<string, unknown> | () => Record<string, unknown>

Connection Parameters for WebSockets connection

Defined in

packages/loaders/url/src/index.ts:99 

credentials

• Optional credentials: RequestCredentials

Request Credentials

Default

'same-origin'

See

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

Inherited from

HTTPExecutorOptions.credentials

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:55

customFetch

• Optional customFetch: string | FetchFn

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

Defined in

packages/loaders/url/src/index.ts:74 

cwd

• Optional cwd: string

Inherited from

BaseLoaderOptions.cwd

Defined in

packages/utils/src/loaders.ts:13 

descriptions

• Optional descriptions: boolean

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

Inherited from

Partial.descriptions

Defined in

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

directiveIsRepeatable

• Optional directiveIsRepeatable: boolean

Whether to include isRepeatable flag on directives. Default: false

Inherited from

Partial.directiveIsRepeatable

Defined in

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

disposable

• Optional disposable: boolean

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

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:85

endpoint

• Optional endpoint: string

Regular HTTP endpoint; defaults to the pointer

Overrides

HTTPExecutorOptions.endpoint

Defined in

packages/loaders/url/src/index.ts:87 

experimentalFragmentVariables

• Optional experimentalFragmentVariables: boolean

Inherited from

BaseLoaderOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:102 

fetch

• Optional fetch: FetchFn

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

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:31

handleAsSDL

• Optional handleAsSDL: boolean

Handle URL as schema SDL

Defined in

packages/loaders/url/src/index.ts:83 

headers

• Optional headers: HeadersConfig | (executorRequest?: ExecutionRequest<any, any, any, Record<string, any>, any>) => HeadersConfig

Additional headers to include when querying the original schema

Inherited from

HTTPExecutorOptions.headers

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:40

ignore

• Optional ignore: string | string[]

Inherited from

BaseLoaderOptions.ignore

Defined in

packages/utils/src/loaders.ts:14 

includeSources

• Optional includeSources: boolean

Inherited from

BaseLoaderOptions.includeSources

Defined in

packages/utils/src/loaders.ts:15 

inputValueDeprecation

• Optional inputValueDeprecation: boolean

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

Inherited from

Partial.inputValueDeprecation

Defined in

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

method

• Optional method: "POST" | "GET"

HTTP method to use when querying the original schema.x

Default

'POST'

Inherited from

HTTPExecutorOptions.method

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:45

noLocation

• Optional noLocation: boolean

Inherited from

BaseLoaderOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:99 

oneOf

• Optional oneOf: boolean

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

Inherited from

Partial.oneOf

Defined in

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

print

• Optional print: (doc: DocumentNode) => string

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

Type declaration

▸ (doc): string

Parameters

Returns

string

Inherited from

HTTPExecutorOptions.print

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:74

retry

• Optional retry: number

Retry attempts

Inherited from

HTTPExecutorOptions.retry

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:59

schemaDescription

• Optional schemaDescription: boolean

Whether to include description field on schema. Default: false

Inherited from

Partial.schemaDescription

Defined in

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

serviceName

• Optional serviceName: string

The name of the service

Inherited from

HTTPExecutorOptions.serviceName

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:20

specifiedByUrl

• Optional specifiedByUrl: boolean

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

Inherited from

Partial.specifiedByUrl

Defined in

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

subscriptionsEndpoint

• Optional subscriptionsEndpoint: string

Subscriptions endpoint; defaults to the endpoint given as HTTP endpoint

Defined in

packages/loaders/url/src/index.ts:91 

subscriptionsProtocol

• Optional subscriptionsProtocol: SubscriptionProtocol

Use specific protocol for subscriptions

Defined in

packages/loaders/url/src/index.ts:95 

timeout

• Optional timeout: number

Timeout in milliseconds

Inherited from

HTTPExecutorOptions.timeout

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:49

useGETForQueries

• Optional useGETForQueries: boolean

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

Default

false

Inherited from

HTTPExecutorOptions.useGETForQueries

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:36

webSocketImpl

• Optional webSocketImpl: string | typeof WebSocket

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

Defined in

packages/loaders/url/src/index.ts:79 

Methods

getDisposeReason

▸ getDisposeReason(): undefined | Error

On dispose abort error

Returns

undefined | Error

Inherited from

HTTPExecutorOptions.getDisposeReason

Defined in

node_modules/@graphql-tools/executor-http/dist/index.d.ts:89