On this page

CodeFileLoader

The CodeFileLoader class exported by @graphql-tools/code-file-loader.

Defined in: packages/loaders/code-file/src/index.ts:84

This loader loads GraphQL documents and type definitions from code files using graphql-tag-pluck.

const documents = await loadDocuments('queries/*.js', {
  loaders: [
    new CodeFileLoader()
  ]
});

Supported extensions include: .ts, .mts, .cts, .tsx, .js, .mjs, .cjs, .jsx, .vue, .svelte, .astro, .gts, .gjs.

Implements

Constructors

Constructor

new CodeFileLoader(config?): CodeFileLoader

Defined in: packages/loaders/code-file/src/index.ts:86

Parameters

config?

CodeFileLoaderConfig

Returns

CodeFileLoader

Methods

canLoad()

canLoad(pointer, options): Promise<boolean>

Defined in: packages/loaders/code-file/src/index.ts:98

Parameters

pointer

string

options

CodeFileLoaderOptions

Returns

Promise<boolean>


canLoadSync()

canLoadSync(pointer, options): boolean

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

Parameters

pointer

string

options

CodeFileLoaderOptions

Returns

boolean


handleSinglePath()

handleSinglePath(location, options): Promise<Source[]>

Defined in: packages/loaders/code-file/src/index.ts:218

Parameters

location

string

options

CodeFileLoaderOptions

Returns

Promise<Source[]>


handleSinglePathSync()

handleSinglePathSync(location, options): Source[] | null

Defined in: packages/loaders/code-file/src/index.ts:280

Parameters

location

string

options

CodeFileLoaderOptions

Returns

Source[] | null


load()

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

Defined in: packages/loaders/code-file/src/index.ts:151

Parameters

pointer

string

options

CodeFileLoaderOptions

Returns

Promise<Source[]>

Implementation of

Loader.load


loadSync()

loadSync(pointer, options): Source[] | null

Defined in: packages/loaders/code-file/src/index.ts:185

Parameters

pointer

string

options

CodeFileLoaderOptions

Returns

Source[] | null

Implementation of

Loader.loadSync


resolveGlobs()

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

Defined in: packages/loaders/code-file/src/index.ts:139

Parameters

glob

string

options

CodeFileLoaderOptions

Returns

Promise<string[]>


resolveGlobsSync()

resolveGlobsSync(glob, options): string[]

Defined in: packages/loaders/code-file/src/index.ts:145

Parameters

glob

string

options

CodeFileLoaderOptions

Returns

string[]