GraphiQL API Documentation
    Preparing search index...

    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;
    }
    Index

    Properties

    dirpath: string
    documents?: UnnormalizedTypeDefPointer | UnnormalizedTypeDefPointer[]
    exclude?: WithList<string>
    extensions: IExtensions
    filepath: string
    include?: WithList<string>
    isLegacy: boolean
    name: string
    schema: Pointer

    Methods

    • Type Parameters

      • T = any

      Parameters

      • name: string

      Returns T

    • Returns Promise<Source[]>

    • Returns Source[]

    • Returns Promise<GraphQLSchema>

    • Parameters

      • out: "DocumentNode"

      Returns Promise<DocumentNode>

    • Parameters

      • out: "GraphQLSchema"

      Returns Promise<GraphQLSchema>

    • Parameters

      • out: "string"

      Returns Promise<string>

    • Returns GraphQLSchema

    • Parameters

      • out: "DocumentNode"

      Returns DocumentNode

    • Parameters

      • out: "GraphQLSchema"

      Returns GraphQLSchema

    • Parameters

      • out: "string"

      Returns string

    • Parameters

      • name: string

      Returns boolean

    • Parameters

      • pointer: Pointer
      • Optionaloptions: Partial<LoadTypedefsOptions>

      Returns Promise<Source[]>

    • Parameters

      • pointer: Pointer
      • Optionaloptions: Partial<LoadTypedefsOptions>

      Returns Source[]

    • Parameters

      • pointer: Pointer

      Returns Promise<GraphQLSchema>

    • Parameters

      • pointer: Pointer
      • out: "string"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns Promise<GraphQLSchema>

    • Parameters

      • pointer: Pointer
      • out: "DocumentNode"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns Promise<DocumentNode>

    • Parameters

      • pointer: Pointer
      • out: "GraphQLSchema"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns Promise<GraphQLSchema>

    • Parameters

      • pointer: Pointer

      Returns GraphQLSchema

    • Parameters

      • pointer: Pointer
      • out: "string"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns GraphQLSchema

    • Parameters

      • pointer: Pointer
      • out: "DocumentNode"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns DocumentNode

    • Parameters

      • pointer: Pointer
      • out: "GraphQLSchema"
      • Optionaloptions: Partial<LoadSchemaOptions>

      Returns GraphQLSchema

    • Parameters

      • filepath: string

      Returns boolean