graphql-tools-monorepo / loaders/github/src / GithubLoaderOptions
Interface: GithubLoaderOptions
loaders/github/src.GithubLoaderOptions
Additional options for loading from GitHub
Hierarchy
-
↳
GithubLoaderOptions
Table of contents
Properties
- allowLegacySDLEmptyFields
- allowLegacySDLImplementsInterfaces
- assumeValid
- assumeValidSDL
- commentDescriptions
- customFetch
- cwd
- experimentalFragmentVariables
- headers
- ignore
- includeSources
- noLocation
- pluckConfig
- token
Properties
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
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
customFetch
• Optional customFetch: FetchFn
Defined in
packages/loaders/github/src/index.ts:51
cwd
• Optional cwd: string
Inherited from
BaseLoaderOptions.cwd
Defined in
packages/utils/src/loaders.ts:13
experimentalFragmentVariables
• Optional experimentalFragmentVariables: boolean
Inherited from
BaseLoaderOptions.experimentalFragmentVariables
Defined in
packages/utils/src/Interfaces.ts:97
headers
• Optional headers: Record<string, string>
Additional headers to pass to the fetch request
Defined in
packages/loaders/github/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
noLocation
• Optional noLocation: boolean
Inherited from
BaseLoaderOptions.noLocation
Defined in
packages/utils/src/Interfaces.ts:94
pluckConfig
• Optional pluckConfig: GraphQLTagPluckOptions
Additional options to pass to graphql-tag-pluck
Defined in
packages/loaders/github/src/index.ts:50
token
• Optional token: string
A GitHub access token
Default
process.env.GITHUB_TOKEN