Skip to main content

types_src.yamlconfig.graphqlhandler

Interface: GraphQLHandler#

types/src.YamlConfig.GraphQLHandler

Handler for remote/local/third-party GraphQL schema

Table of contents#

Properties#

Properties#

batch#

Optional batch: boolean

Batch requests

Defined in: packages/types/src/config.ts:245


customFetch#

Optional customFetch: any

Path to a custom W3 Compatible Fetch Implementation

Defined in: packages/types/src/config.ts:228


endpoint#

endpoint: string

A url or file path to your remote GraphQL endpoint. If you provide a path to a code file(js or ts), other options will be ignored and the schema exported from the file will be used directly.

Defined in: packages/types/src/config.ts:201


introspection#

Optional introspection: string

Path to the introspection You can seperately give schema introspection

Defined in: packages/types/src/config.ts:237


method#

Optional method: GET | POST

HTTP method used for GraphQL operations (Allowed values: GET, POST)

Defined in: packages/types/src/config.ts:220


multipart#

Optional multipart: boolean

Enable multipart/formdata in order to support file uploads

Defined in: packages/types/src/config.ts:241


operationHeaders#

Optional operationHeaders: object

JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime

Type declaration:#

Defined in: packages/types/src/config.ts:210


schemaHeaders#

Optional schemaHeaders: any

JSON object representing the Headers to add to the runtime of the API calls only for schema introspection You can also provide .js or .ts file path that exports schemaHeaders as an object

Defined in: packages/types/src/config.ts:206


useGETForQueries#

Optional useGETForQueries: boolean

Use HTTP GET for Query operations

Defined in: packages/types/src/config.ts:216


useSSEForSubscription#

Optional useSSEForSubscription: boolean

Use Server Sent Events instead of WebSocket for Subscriptions

Defined in: packages/types/src/config.ts:224


webSocketImpl#

Optional webSocketImpl: string

Path to a custom W3 Compatible WebSocket Implementation

Defined in: packages/types/src/config.ts:232