Skip to Content
GraphQL Tools
DocumentationAPILoadersgraphql-filesrcclassesGraphQLFileLoader

Class: GraphQLFileLoader

Defined in: packages/loaders/graphql-file/src/index.ts:78

This loader loads documents and type definitions from .graphql files.

You can load a single source:

const schema = await loadSchema('schema.graphql', { loaders: [ new GraphQLFileLoader() ] });

Or provide a glob pattern to load multiple sources:

const schema = await loadSchema('graphql/*.graphql', { loaders: [ new GraphQLFileLoader() ] });

Implements

Constructors

Constructor

new GraphQLFileLoader(): GraphQLFileLoader

Returns

GraphQLFileLoader

Methods

canLoad()

canLoad(pointer, options): Promise<boolean>

Defined in: packages/loaders/graphql-file/src/index.ts:79

Parameters

pointer

string

options

GraphQLFileLoaderOptions

Returns

Promise<boolean>


canLoadSync()

canLoadSync(pointer, options): boolean

Defined in: packages/loaders/graphql-file/src/index.ts:97

Parameters

pointer

string

options

GraphQLFileLoaderOptions

Returns

boolean


handleFileContent()

handleFileContent(rawSDL, pointer, options): object

Defined in: packages/loaders/graphql-file/src/index.ts:216

Parameters

rawSDL

string

pointer

string

options

GraphQLFileLoaderOptions

Returns

object

document

document: DocumentNode

location

location: string | undefined


load()

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

Defined in: packages/loaders/graphql-file/src/index.ts:144

Parameters

pointer

string

options

GraphQLFileLoaderOptions

Returns

Promise<Source[]>

Implementation of

Loader.load


loadSync()

loadSync(pointer, options): Source[]

Defined in: packages/loaders/graphql-file/src/index.ts:181

Parameters

pointer

string

options

GraphQLFileLoaderOptions

Returns

Source[]

Implementation of

Loader.loadSync


resolveGlobs()

resolveGlobs(glob, options): Promise<string[]>

Defined in: packages/loaders/graphql-file/src/index.ts:118

Parameters

glob

string

options

GraphQLFileLoaderOptions

Returns

Promise<string[]>


resolveGlobsSync()

resolveGlobsSync(glob, options): string[]

Defined in: packages/loaders/graphql-file/src/index.ts:131

Parameters

glob

string

options

GraphQLFileLoaderOptions

Returns

string[]