Interface: GithubLoaderOptions
Defined in: packages/loaders/github/src/index.ts:41
Additional options for loading from GitHub
Extends
Properties
allowLegacySDLEmptyFields?
optionalallowLegacySDLEmptyFields?:boolean
Defined in: packages/utils/src/Interfaces.ts:109
Inherited from
BaseLoaderOptions.allowLegacySDLEmptyFields
allowLegacySDLImplementsInterfaces?
optionalallowLegacySDLImplementsInterfaces?:boolean
Defined in: packages/utils/src/Interfaces.ts:110
Inherited from
BaseLoaderOptions.allowLegacySDLImplementsInterfaces
assumeValid?
optionalassumeValid?:boolean
Defined in: node_modules/graphql/type/schema.d.ts:146
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
assumeValidSDL?
optionalassumeValidSDL?:boolean
Defined in: node_modules/graphql/utilities/buildASTSchema.d.ts:12
Set to true to assume the SDL is valid.
Default: false
Inherited from
BaseLoaderOptions.assumeValidSDL
commentDescriptions?
optionalcommentDescriptions?:boolean
Defined in: packages/utils/src/Interfaces.ts:117
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
customFetch?
optionalcustomFetch?:FetchFn
Defined in: packages/loaders/github/src/index.ts:52
cwd?
optionalcwd?:string
Defined in: packages/utils/src/loaders.ts:13
Inherited from
BaseLoaderOptions.cwd
experimentalFragmentVariables?
optionalexperimentalFragmentVariables?:boolean
Defined in: packages/utils/src/Interfaces.ts:111
Inherited from
BaseLoaderOptions.experimentalFragmentVariables
headers?
optionalheaders?:Record<string,string>
Defined in: packages/loaders/github/src/index.ts:56
Additional headers to pass to the fetch request
ignore?
optionalignore?:string|string[]
Defined in: packages/utils/src/loaders.ts:14
Inherited from
BaseLoaderOptions.ignore
includeSources?
optionalincludeSources?:boolean
Defined in: packages/utils/src/loaders.ts:15
Inherited from
BaseLoaderOptions.includeSources
noLocation?
optionalnoLocation?:boolean
Defined in: packages/utils/src/Interfaces.ts:108
Inherited from
BaseLoaderOptions.noLocation
pluckConfig?
optionalpluckConfig?:GraphQLTagPluckOptions
Defined in: packages/loaders/github/src/index.ts:51
Additional options to pass to graphql-tag-pluck
token?
optionaltoken?:string
Defined in: packages/loaders/github/src/index.ts:47
A GitHub access token
Default
process.env.GITHUB_TOKEN