Class: UrlLoader

Defined in: packages/loaders/url/src/index.ts:125

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>

Constructors

Constructor

new UrlLoader(): UrlLoader

Returns

UrlLoader

Methods

buildHTTPExecutor()

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:126

Parameters

endpoint

string

fetchFn

SyncFetchFn

options?

LoadFromUrlOptions

Returns

SyncExecutor<any, ExecutionExtensions>

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:132

Parameters

endpoint

string

fetchFn

AsyncFetchFn

options?

LoadFromUrlOptions

Returns

AsyncExecutor<any, ExecutionExtensions>

buildSubscriptionExecutor()

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:247

Parameters

subscriptionsEndpoint

string

fetch

SyncFetchFn

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:254

Parameters

subscriptionsEndpoint

string

fetch

AsyncFetchFn

asyncImport

AsyncImportFn

options?

LoadFromUrlOptions

Returns

AsyncExecutor

buildWSExecutor()

buildWSExecutor(subscriptionsEndpoint, webSocketImpl, connectionParams?): Executor

Defined in: packages/loaders/url/src/index.ts:155

Parameters

subscriptionsEndpoint

string

webSocketImpl

typeof WebSocket

connectionParams?

Record<string, unknown> | (() => Record<string, unknown>)

Returns

Executor

buildWSLegacyExecutor()

buildWSLegacyExecutor(subscriptionsEndpoint, WebSocketImpl, options?): Executor

Defined in: packages/loaders/url/src/index.ts:172

Parameters

subscriptionsEndpoint

string

WebSocketImpl

typeof WebSocket

options?

LoadFromUrlOptions

Returns

Executor

getExecutor()

Call Signature

getExecutor(endpoint, asyncImport, options?): AsyncExecutor

Defined in: packages/loaders/url/src/index.ts:299

Parameters

endpoint

string

asyncImport

AsyncImportFn

options?

Omit<LoadFromUrlOptions, "endpoint">

Returns

AsyncExecutor

Call Signature

getExecutor(endpoint, syncImport, options?): SyncExecutor

Defined in: packages/loaders/url/src/index.ts:305

Parameters

endpoint

string

syncImport

SyncImportFn

options?

Omit<LoadFromUrlOptions, "endpoint">

Returns

SyncExecutor

getExecutorAsync()

getExecutorAsync(endpoint, options?): AsyncExecutor

Defined in: packages/loaders/url/src/index.ts:365

Parameters

endpoint

string

options?

Omit<LoadFromUrlOptions, "endpoint">

Returns

AsyncExecutor

getExecutorSync()

getExecutorSync(endpoint, options?): SyncExecutor

Defined in: packages/loaders/url/src/index.ts:372

Parameters

endpoint

string

options?

Omit<LoadFromUrlOptions, "endpoint">

Returns

SyncExecutor

getFetch()

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:185

Parameters

customFetch

string | FetchFn | undefined

importFn

AsyncImportFn

Returns

AsyncFetchFn | PromiseLike<AsyncFetchFn>

Call Signature

getFetch(customFetch, importFn): SyncFetchFn

Defined in: packages/loaders/url/src/index.ts:190

Parameters

customFetch

string | FetchFn | undefined

importFn

SyncImportFn

Returns

SyncFetchFn

getWebSocketImpl()

Call Signature

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

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

Parameters

importFn

AsyncImportFn

options?

LoadFromUrlOptions

Returns

PromiseLike<typeof WebSocket>

Call Signature

getWebSocketImpl(importFn, options?): typeof WebSocket

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

Parameters

importFn

SyncImportFn

options?

LoadFromUrlOptions

Returns

typeof WebSocket

handleSDL()

Call Signature

handleSDL(pointer, fetch, options): Source

Defined in: packages/loaders/url/src/index.ts:376

Parameters

pointer

string

fetch

SyncFetchFn

options

LoadFromUrlOptions

Returns

Source

Call Signature

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

Defined in: packages/loaders/url/src/index.ts:377

Parameters

pointer

string

fetch

AsyncFetchFn

options

LoadFromUrlOptions

Returns

Promise<Source>

load()

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

Defined in: packages/loaders/url/src/index.ts:394

Parameters

pointer

string

options

LoadFromUrlOptions

Returns

Promise<Source[]>

Implementation of

Loader.load

loadSync()

loadSync(pointer, options): Source[]

Defined in: packages/loaders/url/src/index.ts:439

Parameters

pointer

string

options

LoadFromUrlOptions

Returns

Source[]

Implementation of

Loader.loadSync