graphql-tools-monorepo / loaders/url/src / LoadFromUrlOptions
Interface: LoadFromUrlOptions
loaders/url/src.LoadFromUrlOptions
Additional options for loading from a URL
Hierarchy
-
Partial<IntrospectionOptions> -
↳
LoadFromUrlOptions
Table of contents
Properties
- File
- FormData
- allowLegacySDLEmptyFields
- allowLegacySDLImplementsInterfaces
- assumeValid
- assumeValidSDL
- batch
- commentDescriptions
- connectionParams
- credentials
- customFetch
- cwd
- descriptions
- directiveIsRepeatable
- endpoint
- experimentalFragmentVariables
- fetch
- handleAsSDL
- headers
- ignore
- includeSources
- inputValueDeprecation
- method
- noLocation
- retry
- schemaDescription
- specifiedByUrl
- subscriptionsEndpoint
- subscriptionsProtocol
- timeout
- useGETForQueries
- webSocketImpl
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
| Name | Type |
|---|---|
fileBits | BlobPart[] |
fileName | string |
options? | FilePropertyBag |
Returns
File
Type declaration
| Name | Type |
|---|---|
prototype | File |
Inherited from
Defined in
packages/executors/http/src/index.ts:77
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
| Name | Type |
|---|---|
form? | HTMLFormElement |
submitter? | null | HTMLElement |
Returns
FormData
Type declaration
| Name | Type |
|---|---|
prototype | FormData |
Inherited from
Defined in
packages/executors/http/src/index.ts:82
allowLegacySDLEmptyFields
• Optional allowLegacySDLEmptyFields: boolean
Inherited from
BaseLoaderOptions.allowLegacySDLEmptyFields
Defined in
packages/utils/src/Interfaces.ts:95
allowLegacySDLImplementsInterfaces
• Optional allowLegacySDLImplementsInterfaces: boolean
Inherited from
BaseLoaderOptions.allowLegacySDLImplementsInterfaces
Defined in
packages/utils/src/Interfaces.ts:96
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:100
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:103
connectionParams
• Optional connectionParams: Record<string, unknown> | () => Record<string, unknown>
Connection Parameters for WebSockets connection
Defined in
packages/loaders/url/src/index.ts:96
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
packages/executors/http/src/index.ts:68
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:71
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
Overrides
Defined in
packages/loaders/url/src/index.ts:84
experimentalFragmentVariables
• Optional experimentalFragmentVariables: boolean
Inherited from
BaseLoaderOptions.experimentalFragmentVariables
Defined in
packages/utils/src/Interfaces.ts:97
fetch
• Optional fetch: FetchFn
Inherited from
Defined in
packages/executors/http/src/index.ts:47
handleAsSDL
• Optional handleAsSDL: boolean
Handle URL as schema SDL
Defined in
packages/loaders/url/src/index.ts:80
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
Defined in
packages/executors/http/src/index.ts:55
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: "GET" | "POST"
HTTP method to use when querying the original schema.
Inherited from
Defined in
packages/executors/http/src/index.ts:59
noLocation
• Optional noLocation: boolean
Inherited from
BaseLoaderOptions.noLocation
Defined in
packages/utils/src/Interfaces.ts:94
• Optional print: (doc: DocumentNode) => string
Print function for DocumentNode
Type declaration
▸ (doc): string
Parameters
| Name | Type |
|---|---|
doc | DocumentNode |
Returns
string
Inherited from
Defined in
packages/executors/http/src/index.ts:86
retry
• Optional retry: number
Retry attempts
Inherited from
Defined in
packages/executors/http/src/index.ts:72
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:88
subscriptionsProtocol
• Optional subscriptionsProtocol: SubscriptionProtocol
Use specific protocol for subscriptions
Defined in
packages/loaders/url/src/index.ts:92
timeout
• Optional timeout: number
Timeout in milliseconds
Inherited from
Defined in
packages/executors/http/src/index.ts:63
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:51
webSocketImpl
• Optional webSocketImpl: string | typeof WebSocket
Custom WebSocket implementation used by the loaded schema if subscriptions are enabled