Skip to main content

loader

Library for GraphQL schema loading and loaders config processing.

getDocumentLoaders()​

function getDocumentLoaders(loadersList): Promise<Maybe<LoadSchemaOptions>>

Asynchronously returns a valid loaders list for loadSchema based on the plugin config. Import each loader package, and instantiate a loader object.

Parameters​

loadersList​

Maybe<LoaderOption>

the list of loaders defined in the plugin config.

Returns​

Promise<Maybe<LoadSchemaOptions>>

a list of loader objects.

Throws​

an Error if no loader has been loaded, or if an error occurred while importing loaders.

Example​

import { getDocumentLoaders, loadSchema } from "@graphql-markdown/utils/graphql"

const loaderList = {
  GraphQLFileLoader: "@graphql-tools/graphql-file-loader",
};

const loaders = await getDocumentLoaders(loaderList);

const schema = await loadSchema("schema.graphql", {
  loaders,
  rootTypes: { query: "Root", subscription: "" },
});

Defined in​

packages/graphql/src/loader.ts:108

loadSchema()​

function loadSchema(schemaLocation, options): Promise<GraphQLSchema>

Wrapper method for @graphql-tools/load.loadSchema to load asynchronously a GraphQL Schema from a source. The wrapper will load the schema using the loader declared in options. If rootTypes is set in the options, then the schema root types will be overridden to generate custom GraphQL schema.

Parameters​

schemaLocation​

string

the schema location pointer matching the loader.

options​

BuildSchemaOptions & GraphQLParseOptions & object & object & object & Partial<IExecutableSchemaDefinition<any>> & object & object

the schema loaders, and optional rootTypes override.

Returns​

Promise<GraphQLSchema>

a GraphQL schema.

Example​

import { loadSchema } from "@graphql-markdown/utils/graphql"

const schema = await loadSchema("schema.graphql", {
  loaders: [new GraphQLFileLoader()],
  rootTypes: { query: "Root", subscription: "" },
});

Defined in​

packages/graphql/src/loader.ts:43