Docs
API Reference
Interfaces
GithubLoaderOptions

Interface: GithubLoaderOptions

loaders/github/src.GithubLoaderOptions

Additional options for loading from GitHub

Hierarchy

Table of contents

Properties

Properties

allowLegacySDLEmptyFields

Optional allowLegacySDLEmptyFields: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLEmptyFields

Defined in

packages/utils/src/Interfaces.ts:93 (opens in a new tab)


allowLegacySDLImplementsInterfaces

Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

BaseLoaderOptions.allowLegacySDLImplementsInterfaces

Defined in

packages/utils/src/Interfaces.ts:94 (opens in a new tab)


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:101 (opens in a new tab)


customFetch

Optional customFetch: any

Defined in

packages/loaders/github/src/index.ts:38 (opens in a new tab)


cwd

Optional cwd: string

Inherited from

BaseLoaderOptions.cwd

Defined in

packages/utils/src/loaders.ts:13 (opens in a new tab)


experimentalFragmentVariables

Optional experimentalFragmentVariables: boolean

Inherited from

BaseLoaderOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:95 (opens in a new tab)


ignore

Optional ignore: string | string[]

Inherited from

BaseLoaderOptions.ignore

Defined in

packages/utils/src/loaders.ts:14 (opens in a new tab)


noLocation

Optional noLocation: boolean

Inherited from

BaseLoaderOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:92 (opens in a new tab)


pluckConfig

Optional pluckConfig: GraphQLTagPluckOptions

Additional options to pass to graphql-tag-pluck

Defined in

packages/loaders/github/src/index.ts:37 (opens in a new tab)


token

token: string

A GitHub access token

Defined in

packages/loaders/github/src/index.ts:33 (opens in a new tab)