Interface: LoadFromUrlOptions

loaders/url/src.LoadFromUrlOptions

Additional options for loading from a URL

Hierarchy

BaseLoaderOptions
Partial<IntrospectionOptions>

↳ LoadFromUrlOptions

↳↳ PrismaLoaderOptions

allowLegacySDLEmptyFields

• Optional allowLegacySDLEmptyFields: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLEmptyFields

allowLegacySDLImplementsInterfaces

• Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLImplementsInterfaces

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

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

Defined in

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

batch

• Optional batch: boolean

Enable Batching

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:90

connectionParams

• Optional connectionParams: any

Connection Parameters for WebSockets connection

Defined in

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

credentials

• Optional credentials: RequestCredentials

Request Credentials (default: 'same-origin')

See

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

Defined in

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

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:89

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

endpoint

• Optional endpoint: string

Regular HTTP endpoint; defaults to the pointer

Defined in

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

experimentalFragmentVariables

• Optional experimentalFragmentVariables: boolean

Inherited from

BaseLoaderOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:84

graphqlSseOptions

• Optional graphqlSseOptions: any

Deprecated

This is no longer used. Will be removed in the next release

Defined in

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

handleAsSDL

• Optional handleAsSDL: boolean

Handle URL as schema SDL

Defined in

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

headers

• Optional headers: HeadersConfig

Additional headers to include when querying the original schema

Defined in

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

ignore

• Optional ignore: string | string[]

Inherited from

BaseLoaderOptions.ignore

Defined in

packages/utils/src/loaders.ts:14

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.

Defined in

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

multipart

• Optional multipart: boolean

Deprecated

This is no longer used. Will be removed in the next release

Defined in

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

noLocation

• Optional noLocation: boolean

Inherited from

BaseLoaderOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:81

retry

• Optional retry: number

Retry attempts

Defined in

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

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:114

subscriptionsProtocol

• Optional subscriptionsProtocol: SubscriptionProtocol

Use specific protocol for subscriptions

Defined in

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

timeout

• Optional timeout: number

Timeout in milliseconds

Defined in

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

useGETForQueries

• Optional useGETForQueries: boolean

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

Defined in

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

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:98

LoadFilesOptions MappingInstruction