Docs
API Reference
Interfaces
LoadFromUrlOptions

Interface: LoadFromUrlOptions

loaders/url/src.LoadFromUrlOptions

Additional options for loading from a URL

Hierarchy

Table of contents

Properties

Properties

allowLegacySDLEmptyFields

Optional allowLegacySDLEmptyFields: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLEmptyFields

Defined in

packages/utils/src/Interfaces.ts:93 (opens in a new tab)


allowLegacySDLImplementsInterfaces

Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLImplementsInterfaces

Defined in

packages/utils/src/Interfaces.ts:94 (opens in a new tab)


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:98 (opens in a new tab)


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:101 (opens in a new tab)


connectionParams

Optional connectionParams: any

Connection Parameters for WebSockets connection

Defined in

packages/loaders/url/src/index.ts:94 (opens in a new tab)


credentials

Optional credentials: RequestCredentials

Request Credentials (default: 'same-origin')

See

https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials (opens in a new tab)

Inherited from

HTTPExecutorOptions.credentials

Defined in

packages/executors/http/src/index.ts:62 (opens in a new tab)


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:69 (opens in a new tab)


cwd

Optional cwd: string

Inherited from

BaseLoaderOptions.cwd

Defined in

packages/utils/src/loaders.ts:13 (opens in a new tab)


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


endpoint

Optional endpoint: string

Regular HTTP endpoint; defaults to the pointer

Overrides

HTTPExecutorOptions.endpoint

Defined in

packages/loaders/url/src/index.ts:82 (opens in a new tab)


experimentalFragmentVariables

Optional experimentalFragmentVariables: boolean

Inherited from

BaseLoaderOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:95 (opens in a new tab)


fetch

Optional fetch: FetchFn

Inherited from

HTTPExecutorOptions.fetch

Defined in

packages/executors/http/src/index.ts:41 (opens in a new tab)


handleAsSDL

Optional handleAsSDL: boolean

Handle URL as schema SDL

Defined in

packages/loaders/url/src/index.ts:78 (opens in a new tab)


headers

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

Additional headers to include when querying the original schema

Inherited from

HTTPExecutorOptions.headers

Defined in

packages/executors/http/src/index.ts:49 (opens in a new tab)


ignore

Optional ignore: string | string[]

Inherited from

BaseLoaderOptions.ignore

Defined in

packages/utils/src/loaders.ts:14 (opens in a new tab)


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: "GET" | "POST"

HTTP method to use when querying the original schema.

Inherited from

HTTPExecutorOptions.method

Defined in

packages/executors/http/src/index.ts:53 (opens in a new tab)


noLocation

Optional noLocation: boolean

Inherited from

BaseLoaderOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:92 (opens in a new tab)


retry

Optional retry: number

Retry attempts

Inherited from

HTTPExecutorOptions.retry

Defined in

packages/executors/http/src/index.ts:66 (opens in a new tab)


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


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:86 (opens in a new tab)


subscriptionsProtocol

Optional subscriptionsProtocol: SubscriptionProtocol

Use specific protocol for subscriptions

Defined in

packages/loaders/url/src/index.ts:90 (opens in a new tab)


timeout

Optional timeout: number

Timeout in milliseconds

Inherited from

HTTPExecutorOptions.timeout

Defined in

packages/executors/http/src/index.ts:57 (opens in a new tab)


useGETForQueries

Optional useGETForQueries: boolean

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

Inherited from

HTTPExecutorOptions.useGETForQueries

Defined in

packages/executors/http/src/index.ts:45 (opens in a new tab)


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:74 (opens in a new tab)