graphql-tools-monorepo / loaders/apollo-engine/src / ApolloEngineOptions
Interface: ApolloEngineOptions
loaders/apollo-engine/src.ApolloEngineOptions
Additional options for loading from Apollo Engine
Hierarchy
-
↳
ApolloEngineOptions
Table of contents
Properties
- allowLegacySDLEmptyFields
- allowLegacySDLImplementsInterfaces
- assumeValid
- assumeValidSDL
- commentDescriptions
- cwd
- engine
- experimentalFragmentVariables
- graph
- headers
- ignore
- includeSources
- noLocation
- variant
Properties
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
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
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
cwd
• Optional
cwd: string
Inherited from
BaseLoaderOptions.cwd
Defined in
packages/utils/src/loaders.ts:13
engine
• engine: Object
Type declaration
Name | Type |
---|---|
apiKey | string |
endpoint? | string |
Defined in
packages/loaders/apollo-engine/src/index.ts:9
experimentalFragmentVariables
• Optional
experimentalFragmentVariables: boolean
Inherited from
BaseLoaderOptions.experimentalFragmentVariables
Defined in
packages/utils/src/Interfaces.ts:102
graph
• graph: string
Defined in
packages/loaders/apollo-engine/src/index.ts:13
headers
• Optional
headers: Record
<string
, string
>
Defined in
packages/loaders/apollo-engine/src/index.ts:15
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
noLocation
• Optional
noLocation: boolean
Inherited from
BaseLoaderOptions.noLocation
Defined in
packages/utils/src/Interfaces.ts:99
variant
• variant: string