Interface: PrismaLoaderOptions
loaders/prisma/src.PrismaLoaderOptions
additional options for loading from a prisma.yml file
Hierarchy
-
↳
PrismaLoaderOptions
Table of contents
Properties
- allowLegacySDLEmptyFields
- allowLegacySDLImplementsInterfaces
- assumeValid
- assumeValidSDL
- batch
- commentDescriptions
- connectionParams
- credentials
- customFetch
- cwd
- descriptions
- directiveIsRepeatable
- endpoint
- envVars
- experimentalFragmentVariables
- graceful
- graphqlSseOptions
- handleAsSDL
- headers
- ignore
- inputValueDeprecation
- method
- multipart
- noLocation
- retry
- schemaDescription
- specifiedByUrl
- subscriptionsEndpoint
- subscriptionsProtocol
- timeout
- useGETForQueries
- webSocketImpl
Properties
allowLegacySDLEmptyFields
• Optional allowLegacySDLEmptyFields: boolean
Inherited from
LoadFromUrlOptions.allowLegacySDLEmptyFields
Defined in
packages/utils/src/Interfaces.ts:82
allowLegacySDLImplementsInterfaces
• Optional allowLegacySDLImplementsInterfaces: boolean
Inherited from
LoadFromUrlOptions.allowLegacySDLImplementsInterfaces
Defined in
packages/utils/src/Interfaces.ts:83
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
LoadFromUrlOptions.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
LoadFromUrlOptions.assumeValidSDL
Defined in
node_modules/graphql/utilities/buildASTSchema.d.ts:12
batch
• Optional batch: boolean
Enable Batching
Inherited from
Defined in
packages/loaders/url/src/index.ts:139
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
LoadFromUrlOptions.commentDescriptions
Defined in
packages/utils/src/Interfaces.ts:90
connectionParams
• Optional connectionParams: any
Connection Parameters for WebSockets connection
Inherited from
LoadFromUrlOptions.connectionParams
Defined in
packages/loaders/url/src/index.ts:135
credentials
• Optional credentials: RequestCredentials
Request Credentials (default: 'same-origin')
See
https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
Inherited from
LoadFromUrlOptions.credentials
Defined in
packages/loaders/url/src/index.ts:131
customFetch
• Optional customFetch: string | FetchFn
A custom fetch implementation to use when querying the original schema.
Defaults to cross-fetch
Inherited from
LoadFromUrlOptions.customFetch
Defined in
packages/loaders/url/src/index.ts:89
cwd
• Optional cwd: string
Overrides
Defined in
packages/loaders/prisma/src/index.ts:16
descriptions
• Optional descriptions: boolean
Whether to include descriptions in the introspection result. Default: true
Inherited from
LoadFromUrlOptions.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
LoadFromUrlOptions.directiveIsRepeatable
Defined in
node_modules/graphql/utilities/getIntrospectionQuery.d.ts:18
endpoint
• Optional endpoint: string
Regular HTTP endpoint; defaults to the pointer
Inherited from
Defined in
packages/loaders/url/src/index.ts:110
envVars
• Optional envVars: Object
Index signature
▪ [key: string]: string
Defined in
packages/loaders/prisma/src/index.ts:14
experimentalFragmentVariables
• Optional experimentalFragmentVariables: boolean
Inherited from
LoadFromUrlOptions.experimentalFragmentVariables
Defined in
packages/utils/src/Interfaces.ts:84
graceful
• Optional graceful: boolean
Defined in
packages/loaders/prisma/src/index.ts:15
graphqlSseOptions
• Optional graphqlSseOptions: any
Deprecated
This is no longer used. Will be removed in the next release
Inherited from
LoadFromUrlOptions.graphqlSseOptions
Defined in
packages/loaders/url/src/index.ts:146
handleAsSDL
• Optional handleAsSDL: boolean
Handle URL as schema SDL
Inherited from
LoadFromUrlOptions.handleAsSDL
Defined in
packages/loaders/url/src/index.ts:106
headers
• Optional headers: HeadersConfig
Additional headers to include when querying the original schema
Inherited from
Defined in
packages/loaders/url/src/index.ts:84
ignore
• Optional ignore: string | string[]
Inherited from
Defined in
packages/utils/src/loaders.ts:14
inputValueDeprecation
• Optional inputValueDeprecation: boolean
Whether target GraphQL server support deprecation of input values. Default: false
Inherited from
LoadFromUrlOptions.inputValueDeprecation
Defined in
node_modules/graphql/utilities/getIntrospectionQuery.d.ts:28
method
• Optional method: "POST" | "GET"
HTTP method to use when querying the original schema.
Inherited from
Defined in
packages/loaders/url/src/index.ts:93
multipart
• Optional multipart: boolean
Deprecated
This is no longer used. Will be removed in the next release
Inherited from
Defined in
packages/loaders/url/src/index.ts:150
noLocation
• Optional noLocation: boolean
Inherited from
Defined in
packages/utils/src/Interfaces.ts:81
retry
• Optional retry: number
Retry attempts
Inherited from
Defined in
packages/loaders/url/src/index.ts:122
schemaDescription
• Optional schemaDescription: boolean
Whether to include description field on schema.
Default: false
Inherited from
LoadFromUrlOptions.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
LoadFromUrlOptions.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
Inherited from
LoadFromUrlOptions.subscriptionsEndpoint
Defined in
packages/loaders/url/src/index.ts:114
subscriptionsProtocol
• Optional subscriptionsProtocol: SubscriptionProtocol
Use specific protocol for subscriptions
Inherited from
LoadFromUrlOptions.subscriptionsProtocol
Defined in
packages/loaders/url/src/index.ts:118
timeout
• Optional timeout: number
Timeout in milliseconds
Inherited from
Defined in
packages/loaders/url/src/index.ts:126
useGETForQueries
• Optional useGETForQueries: boolean
Whether to use the GET HTTP method for queries when querying the original schema
Inherited from
LoadFromUrlOptions.useGETForQueries
Defined in
packages/loaders/url/src/index.ts:102
webSocketImpl
• Optional webSocketImpl: string | typeof WebSocket
Custom WebSocket implementation used by the loaded schema if subscriptions are enabled
Inherited from
LoadFromUrlOptions.webSocketImpl