The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

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:269


customFetch#

Optional customFetch: any

Path to a custom W3 Compatible Fetch Implementation

Defined in#

packages/types/src/config.ts:252


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:229


introspection#

Optional introspection: string

Path to the introspection You can seperately give schema introspection

Defined in#

packages/types/src/config.ts:261


method#

Optional method: "GET" | "POST"

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

Defined in#

packages/types/src/config.ts:248


multipart#

Optional multipart: boolean

Enable multipart/formdata in order to support file uploads

Defined in#

packages/types/src/config.ts:265


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:238


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:234


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:275


useGETForQueries#

Optional useGETForQueries: boolean

Use HTTP GET for Query operations

Defined in#

packages/types/src/config.ts:244


webSocketImpl#

Optional webSocketImpl: string

Path to a custom W3 Compatible WebSocket Implementation

Defined in#

packages/types/src/config.ts:256