graphql-tools-monorepo / loaders/url/src / UrlLoader

Class: UrlLoader

loaders/url/src.UrlLoader

This loader loads a schema from a URL. The loaded schema is a fully-executable, remote schema since it’s created using @graphql-tools/wrap.

const schema = await loadSchema('http://localhost:3000/graphql', {
  loaders: [
    new UrlLoader(),
  ]
});

Implements

• Loader<LoadFromUrlOptions>

Table of contents

Constructors

• constructor

Methods

• buildHTTPExecutor
• buildSubscriptionExecutor
• buildWSExecutor
• buildWSLegacyExecutor
• getExecutor
• getExecutorAsync
• getExecutorSync
• getFetch
• getWebSocketImpl
• handleSDL
• load
• loadSync

Constructors

constructor

• new UrlLoader(): UrlLoader

Returns

UrlLoader

Methods

buildHTTPExecutor

▸ buildHTTPExecutor(endpoint, fetchFn, options?): SyncExecutor<any, ExecutionExtensions>

Parameters

Returns

SyncExecutor<any, ExecutionExtensions>

Defined in

packages/loaders/url/src/index.ts:128

▸ buildHTTPExecutor(endpoint, fetchFn, options?): AsyncExecutor<any, ExecutionExtensions>

Parameters

Returns

AsyncExecutor<any, ExecutionExtensions>

Defined in

packages/loaders/url/src/index.ts:134

buildSubscriptionExecutor

▸ buildSubscriptionExecutor(subscriptionsEndpoint, fetch, syncImport, options?): SyncExecutor

Parameters

Returns

SyncExecutor

Defined in

packages/loaders/url/src/index.ts:248

▸ buildSubscriptionExecutor(subscriptionsEndpoint, fetch, asyncImport, options?): AsyncExecutor

Parameters

Returns

AsyncExecutor

Defined in

packages/loaders/url/src/index.ts:255

buildWSExecutor

▸ buildWSExecutor(subscriptionsEndpoint, webSocketImpl, connectionParams?): Executor

Parameters

Returns

Executor

Defined in

packages/loaders/url/src/index.ts:157

buildWSLegacyExecutor

▸ buildWSLegacyExecutor(subscriptionsEndpoint, WebSocketImpl, options?): Executor

Parameters

Returns

Executor

Defined in

packages/loaders/url/src/index.ts:173

getExecutor

▸ getExecutor(endpoint, asyncImport, options?): AsyncExecutor

Parameters

Returns

AsyncExecutor

Defined in

packages/loaders/url/src/index.ts:294

▸ getExecutor(endpoint, syncImport, options?): SyncExecutor

Parameters

Returns

SyncExecutor

Defined in

packages/loaders/url/src/index.ts:300

getExecutorAsync

▸ getExecutorAsync(endpoint, options?): AsyncExecutor

Parameters

Returns

AsyncExecutor

Defined in

packages/loaders/url/src/index.ts:351

getExecutorSync

▸ getExecutorSync(endpoint, options?): SyncExecutor

Parameters

Returns

SyncExecutor

Defined in

packages/loaders/url/src/index.ts:358

getFetch

▸ getFetch(customFetch, importFn): AsyncFetchFn | PromiseLike<AsyncFetchFn>

Parameters

Returns

AsyncFetchFn | PromiseLike<AsyncFetchFn>

Defined in

packages/loaders/url/src/index.ts:186

▸ getFetch(customFetch, importFn): SyncFetchFn

Parameters

Returns

SyncFetchFn

Defined in

packages/loaders/url/src/index.ts:191

getWebSocketImpl

▸ getWebSocketImpl(importFn, options?): PromiseLike<typeof WebSocket>

Parameters

Returns

PromiseLike<typeof WebSocket>

Defined in

packages/loaders/url/src/index.ts:224

▸ getWebSocketImpl(importFn, options?): typeof WebSocket

Parameters

Returns

typeof WebSocket

Defined in

packages/loaders/url/src/index.ts:229

handleSDL

▸ handleSDL(pointer, fetch, options): Source

Parameters

Returns

Source

Defined in

packages/loaders/url/src/index.ts:362

▸ handleSDL(pointer, fetch, options): Promise<Source>

Parameters

Returns

Promise<Source>

Defined in

packages/loaders/url/src/index.ts:363

load

▸ load(pointer, options): Promise<Source[]>

Parameters

Returns

Promise<Source[]>

Implementation of

Loader.load

Defined in

packages/loaders/url/src/index.ts:381

loadSync

▸ loadSync(pointer, options): Source[]

Parameters

Returns

Source[]

Implementation of

Loader.loadSync

Defined in

packages/loaders/url/src/index.ts:426