Docs
API
Interfaces
GraphQLHandlerHTTPConfiguration

Interface: GraphQLHandlerHTTPConfiguration

types/src.YamlConfig.GraphQLHandlerHTTPConfiguration

Table of contents

Properties

Properties

batch

Optional batch: boolean

Enable/Disable automatic query batching

Defined in

packages/types/src/config.ts:258


credentials

Optional credentials: "omit" | "include" | "disable"

Request Credentials if your environment supports it. See more

Some environments like CF Workers don't even want to have this set. So if you have problems like that. Just pass disable here. (Allowed values: omit, include, disable)

Defined in

packages/types/src/config.ts:227


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 separately give schema introspection

Defined in

packages/types/src/config.ts:236


method

Optional method: "GET" | "POST"

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

Defined in

packages/types/src/config.ts:219


multipart

Optional multipart: boolean

Enable multipart/formdata in order to support file uploads

Defined in

packages/types/src/config.ts:240


operationHeaders

Optional operationHeaders: Object

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

Index signature

▪ [k: string]: any

Defined in

packages/types/src/config.ts:209


retry

Optional retry: number

Retry attempts if fails

Defined in

packages/types/src/config.ts:250


schemaHeaders

Optional schemaHeaders: any

JSON object representing the Headers to add to the runtime of the API calls only for schema introspection

Defined in

packages/types/src/config.ts:205


subscriptionsProtocol

Optional subscriptionsProtocol: "SSE" | "WS" | "LEGACY_WS"

SSE - Server Sent Events WS - New graphql-ws LEGACY_WS - Legacy subscriptions-transport-ws (Allowed values: SSE, WS, LEGACY_WS)

Defined in

packages/types/src/config.ts:246


timeout

Optional timeout: number

Timeout in milliseconds

Defined in

packages/types/src/config.ts:254


useGETForQueries

Optional useGETForQueries: boolean

Use HTTP GET for Query operations

Defined in

packages/types/src/config.ts:215


webSocketImpl

Optional webSocketImpl: string

Path to a custom W3 Compatible WebSocket Implementation

Defined in

packages/types/src/config.ts:231