Interface GraphQLProjectConfig

Types and enums to use across projects

interface GraphQLProjectConfig {
    dirpath: string;
    documents?: UnnormalizedTypeDefPointer | UnnormalizedTypeDefPointer[];
    exclude?: WithList<string>;
    extensions: IExtensions;
    filepath: string;
    include?: WithList<string>;
    isLegacy: boolean;
    name: string;
    schema: Pointer;
    extension<T = any>(name: string): T;
    getDocuments(): Promise<Source[]>;
    getDocumentsSync(): Source[];
    getSchema(): Promise<GraphQLSchema>;
    getSchema(out: "DocumentNode"): Promise<DocumentNode>;
    getSchema(out: "GraphQLSchema"): Promise<GraphQLSchema>;
    getSchema(out: "string"): Promise<string>;
    getSchemaSync(): GraphQLSchema;
    getSchemaSync(out: "DocumentNode"): DocumentNode;
    getSchemaSync(out: "GraphQLSchema"): GraphQLSchema;
    getSchemaSync(out: "string"): string;
    hasExtension(name: string): boolean;
    loadDocuments(
        pointer: Pointer,
        options?: Partial<LoadTypedefsOptions>,
    ): Promise<Source[]>;
    loadDocumentsSync(
        pointer: Pointer,
        options?: Partial<LoadTypedefsOptions>,
    ): Source[];
    loadSchema(pointer: Pointer): Promise<GraphQLSchema>;
    loadSchema(
        pointer: Pointer,
        out: "string",
        options?: Partial<LoadSchemaOptions>,
    ): Promise<GraphQLSchema>;
    loadSchema(
        pointer: Pointer,
        out: "DocumentNode",
        options?: Partial<LoadSchemaOptions>,
    ): Promise<DocumentNode>;
    loadSchema(
        pointer: Pointer,
        out: "GraphQLSchema",
        options?: Partial<LoadSchemaOptions>,
    ): Promise<GraphQLSchema>;
    loadSchemaSync(pointer: Pointer): GraphQLSchema;
    loadSchemaSync(
        pointer: Pointer,
        out: "string",
        options?: Partial<LoadSchemaOptions>,
    ): GraphQLSchema;
    loadSchemaSync(
        pointer: Pointer,
        out: "DocumentNode",
        options?: Partial<LoadSchemaOptions>,
    ): DocumentNode;
    loadSchemaSync(
        pointer: Pointer,
        out: "GraphQLSchema",
        options?: Partial<LoadSchemaOptions>,
    ): GraphQLSchema;
    match(filepath: string): boolean;
}

Properties

`Readonly`dirpath

dirpath: string

`Optional` `Readonly`documents

documents?: UnnormalizedTypeDefPointer | UnnormalizedTypeDefPointer[]

`Optional` `Readonly`exclude

exclude?: WithList<string>

`Readonly`extensions

extensions: IExtensions

`Readonly`filepath

filepath: string

`Optional` `Readonly`include

include?: WithList<string>

`Readonly`isLegacy

isLegacy: boolean

`Readonly`name

name: string

`Readonly`schema

schema: Pointer

Methods

extension

extension<T = any>(name: string): T
Type Parameters
- T = any
Parameters
- name: string
Returns T
- Defined in node_modules/graphql-config/typings/project-config.d.ts:27

getDocuments

getDocuments(): Promise<Source[]>
Returns Promise<Source[]>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:36

getDocumentsSync

getDocumentsSync(): Source[]
Returns Source[]
- Defined in node_modules/graphql-config/typings/project-config.d.ts:37

getSchema

getSchema(): Promise<GraphQLSchema>
Returns Promise<GraphQLSchema>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:28
getSchema(out: "DocumentNode"): Promise<DocumentNode>
Parameters
- out: "DocumentNode"
Returns Promise<DocumentNode>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:29
getSchema(out: "GraphQLSchema"): Promise<GraphQLSchema>
Parameters
- out: "GraphQLSchema"
Returns Promise<GraphQLSchema>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:30
getSchema(out: "string"): Promise<string>
Parameters
- out: "string"
Returns Promise<string>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:31

getSchemaSync

getSchemaSync(): GraphQLSchema
Returns GraphQLSchema
- Defined in node_modules/graphql-config/typings/project-config.d.ts:32
getSchemaSync(out: "DocumentNode"): DocumentNode
Parameters
- out: "DocumentNode"
Returns DocumentNode
- Defined in node_modules/graphql-config/typings/project-config.d.ts:33
getSchemaSync(out: "GraphQLSchema"): GraphQLSchema
Parameters
- out: "GraphQLSchema"
Returns GraphQLSchema
- Defined in node_modules/graphql-config/typings/project-config.d.ts:34
getSchemaSync(out: "string"): string
Parameters
- out: "string"
Returns string
- Defined in node_modules/graphql-config/typings/project-config.d.ts:35

hasExtension

hasExtension(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in node_modules/graphql-config/typings/project-config.d.ts:26

loadDocuments

loadDocuments(
pointer: Pointer,
options?: Partial<LoadTypedefsOptions>,
): Promise<Source[]>
Parameters
- pointer: Pointer
- Optionaloptions: Partial<LoadTypedefsOptions>
Returns Promise<Source[]>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:46

loadDocumentsSync

loadDocumentsSync(
pointer: Pointer,
options?: Partial<LoadTypedefsOptions>,
): Source[]
Parameters
- pointer: Pointer
- Optionaloptions: Partial<LoadTypedefsOptions>
Returns Source[]
- Defined in node_modules/graphql-config/typings/project-config.d.ts:47

loadSchema

loadSchema(pointer: Pointer): Promise<GraphQLSchema>
Parameters
- pointer: Pointer
Returns Promise<GraphQLSchema>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:38
loadSchema(
    pointer: Pointer,
    out: "string",
    options?: Partial<LoadSchemaOptions>,
): Promise<GraphQLSchema>
Parameters
- pointer: Pointer
- out: "string"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns Promise<GraphQLSchema>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:39
loadSchema(
    pointer: Pointer,
    out: "DocumentNode",
    options?: Partial<LoadSchemaOptions>,
): Promise<DocumentNode>
Parameters
- pointer: Pointer
- out: "DocumentNode"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns Promise<DocumentNode>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:40
loadSchema(
    pointer: Pointer,
    out: "GraphQLSchema",
    options?: Partial<LoadSchemaOptions>,
): Promise<GraphQLSchema>
Parameters
- pointer: Pointer
- out: "GraphQLSchema"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns Promise<GraphQLSchema>
- Defined in node_modules/graphql-config/typings/project-config.d.ts:41

loadSchemaSync

loadSchemaSync(pointer: Pointer): GraphQLSchema
Parameters
- pointer: Pointer
Returns GraphQLSchema
- Defined in node_modules/graphql-config/typings/project-config.d.ts:42
loadSchemaSync(
    pointer: Pointer,
    out: "string",
    options?: Partial<LoadSchemaOptions>,
): GraphQLSchema
Parameters
- pointer: Pointer
- out: "string"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns GraphQLSchema
- Defined in node_modules/graphql-config/typings/project-config.d.ts:43
loadSchemaSync(
    pointer: Pointer,
    out: "DocumentNode",
    options?: Partial<LoadSchemaOptions>,
): DocumentNode
Parameters
- pointer: Pointer
- out: "DocumentNode"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns DocumentNode
- Defined in node_modules/graphql-config/typings/project-config.d.ts:44
loadSchemaSync(
    pointer: Pointer,
    out: "GraphQLSchema",
    options?: Partial<LoadSchemaOptions>,
): GraphQLSchema
Parameters
- pointer: Pointer
- out: "GraphQLSchema"
- Optionaloptions: Partial<LoadSchemaOptions>
Returns GraphQLSchema
- Defined in node_modules/graphql-config/typings/project-config.d.ts:45

match

match(filepath: string): boolean
Parameters
- filepath: string
Returns boolean
- Defined in node_modules/graphql-config/typings/project-config.d.ts:48

Interface GraphQLProjectConfig

Index

Properties

Methods

Properties

Readonlydirpath

Optional Readonlydocuments

Optional Readonlyexclude

Readonlyextensions

Readonlyfilepath

Optional Readonlyinclude

ReadonlyisLegacy

Readonlyname

Readonlyschema

Methods

extension

Type Parameters

Parameters

Returns T

getDocuments

Returns Promise<Source[]>

getDocumentsSync

Returns Source[]

getSchema

Returns Promise<GraphQLSchema>

Parameters

Returns Promise<DocumentNode>

Parameters

Returns Promise<GraphQLSchema>

Parameters

Returns Promise<string>

getSchemaSync

Returns GraphQLSchema

Parameters

Returns DocumentNode

Parameters

Returns GraphQLSchema

Parameters

Returns string

hasExtension

Parameters

Returns boolean

loadDocuments

Parameters

Returns Promise<Source[]>

loadDocumentsSync

Parameters

Returns Source[]

loadSchema

Parameters

Returns Promise<GraphQLSchema>

Parameters

Returns Promise<GraphQLSchema>

Parameters

Returns Promise<DocumentNode>

Parameters

Returns Promise<GraphQLSchema>

loadSchemaSync

Parameters

Returns GraphQLSchema

Parameters

Returns GraphQLSchema

Parameters

Returns DocumentNode

Parameters

Returns GraphQLSchema

match

Parameters

Returns boolean

Settings

On This Page

`Readonly`dirpath

`Optional` `Readonly`documents

`Optional` `Readonly`exclude

`Readonly`extensions

`Readonly`filepath

`Optional` `Readonly`include

`Readonly`isLegacy

`Readonly`name

`Readonly`schema