Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateFetcherOptions

Options for creating a simple, spec-compliant GraphiQL fetcher

Hierarchy

  • CreateFetcherOptions

Index

Properties

Optional enableIncrementalDelivery

enableIncrementalDelivery: undefined | false | true

You can disable the usage of the fetch-multipart-graphql library entirely, defaulting to a simple fetch POST implementation.

Optional fetch

fetch: typeof fetch

The fetch implementation, in case the user needs to override this for SSR or other purposes. this does not override the fetch-multipart-graphql default fetch behavior yet.

Optional headers

headers: Record<string, string>

Headers you can provide statically.

If you enable the headers editor and the user provides A header you set statically here, it will be overridden by their value.

Optional legacyClient

legacyClient: any

alias for legacyWsClient

Optional legacyWsClient

legacyWsClient: any

legacyWsClient implementation that matches subscriptions-transport-ws signature, whether via new SubscriptionsClient() itself or another client with a similar signature.

Optional schemaFetcher

schemaFetcher: Fetcher

An optional custom fetcher specifically for your schema. For most cases the url and headers property should have you covered.

Optional subscriptionUrl

subscriptionUrl: undefined | string

url for websocket subscription requests

url

url: string

url for HTTP(S) requests. required!

Optional wsClient

wsClient: Client

wsClient implementation that matches ws-graphql signature, whether via createClient() itself or another client.

Optional wsConnectionParams

wsConnectionParams: ClientOptions["connectionParams"]

Websockets connection params used when you provide subscriptionUrl. graphql-ws ClientOptions.connectionParams

Generated using TypeDoc