GraphiQL API Documentation
    Preparing search index...

    Type Alias SchemaConfig

    Inspired by the monaco-json schema object in DiagnosticSettings["schemas"], which we use :)

    You have many schema format options to provide, choose one!

    For large schemas, try different formats to see what is most efficient for you.

    type SchemaConfig = {
        buildSchemaOptions?: BuildSchemaOptions;
        customScalarSchemas?: Record<string, JSONSchema6>;
        documentAST?: DocumentNode;
        documentString?: string;
        fileMatch?: string[];
        introspectionJSON?: IntrospectionQuery;
        introspectionJSONString?: string;
        schema?: GraphQLSchema;
        uri: string;
    }
    Index

    Properties

    buildSchemaOptions? customScalarSchemas? documentAST? documentString? fileMatch? introspectionJSON? introspectionJSONString? schema? uri

    Properties

    buildSchemaOptions?: BuildSchemaOptions

    provide custom options when using buildClientSchema, buildASTSchema, etc

    customScalarSchemas?: Record<string, JSONSchema6>

    JSON schemas ued for custom scalars

    {
     customScalarSchemas: {
       DateTime: {
         type: "string",
         format: "date-time"
       }
     }
    documentAST?: DocumentNode

    A GraphQL DocumentNode AST

    documentString?: string

    An SDL document string

    fileMatch?: string[]

    An array of URIs or globs to associate with this schema in the language worker Uses picomatch which supports many common expressions except brackets Only necessary if you provide more than one schema, otherwise it defaults to the sole schema

    introspectionJSON?: IntrospectionQuery

    A parsed JSON literal of the introspection results

    introspectionJSONString?: string

    A stringified introspection JSON result

    schema?: GraphQLSchema

    A GraphQLSchema instance

    uri: string

    A unique uri string for this schema. Model data will eventually be set for this URI for definition lookup

    Settings

    Member Visibility

    On This Page

    Properties