Interface RemoteSchemaOptions

interface RemoteSchemaOptions {
    apollo?: ApolloConfigInput;
    cache?: KeyValueCache<string>;
    cacheControl?: boolean | CacheControlExtensionOptions;
    context?: object | ContextFunction<any, object>;
    dataSources?: (() => DataSources<object>);
    debug?: boolean;
    engine?: boolean | EngineReportingOptions<object>;
    executor?: GraphQLExecutor;
    experimental_approximateDocumentStoreMiB?: number;
    extensions?: (() => GraphQLExtension<any>)[];
    fieldResolver?: GraphQLFieldResolver<any, object>;
    formatError?: ((error: GraphQLError) => GraphQLFormattedError<Record<string, any>>);
    formatResponse?: ((response: GraphQLResponse, requestContext: GraphQLRequestContext<object>) => GraphQLResponse);
    gateway?: GraphQLService;
    introspection?: boolean;
    logger?: Logger;
    mockEntireSchema?: boolean;
    mocks?: boolean | IMocks;
    modules?: GraphQLSchemaModule[];
    parseOptions?: GraphQLParseOptions;
    path: string;
    persistedQueries?: false | PersistedQueryOptions;
    playground?: PlaygroundConfig;
    plugins?: PluginDefinition[];
    resolvers?: IResolvers<any, any> | IResolvers<any, any>[];
    rootValue?: any;
    schema?: GraphQLSchema;
    schemaDirectives?: Record<string, typeof SchemaDirectiveVisitor>;
    stopOnTerminationSignals?: boolean;
    subscriptions?: string | false | Partial<SubscriptionServerOptions>;
    tracing?: boolean;
    typeDefs?:
        | string
        | string[]
        | DocumentNode
        | DocumentNode[];
    uploads?: boolean | FileUploadOptions;
    validationRules?: ((context: ValidationContext) => any)[];
}

Hierarchy

  • Config
    • RemoteSchemaOptions

Properties

apollo? cache? cacheControl? context? dataSources? debug? engine? executor? experimental_approximateDocumentStoreMiB? extensions? fieldResolver? formatError? formatResponse? gateway? introspection? logger? mockEntireSchema? mocks? modules? parseOptions? path persistedQueries? playground? plugins? resolvers? rootValue? schema? schemaDirectives? stopOnTerminationSignals? subscriptions? tracing? typeDefs? uploads? validationRules?

Properties

Optionalapollo

apollo?: ApolloConfigInput

Optionalcache

cache?: KeyValueCache<string>

OptionalcacheControl

cacheControl?: boolean | CacheControlExtensionOptions

Optionalcontext

context?: object | ContextFunction<any, object>

OptionaldataSources

dataSources?: (() => DataSources<object>)

Optionaldebug

debug?: boolean

Optionalengine

engine?: boolean | EngineReportingOptions<object>

Optionalexecutor

executor?: GraphQLExecutor

Optionalexperimental_approximateDocumentStoreMiB

experimental_approximateDocumentStoreMiB?: number

Optionalextensions

extensions?: (() => GraphQLExtension<any>)[]

OptionalfieldResolver

fieldResolver?: GraphQLFieldResolver<any, object>

OptionalformatError

formatError?: ((error: GraphQLError) => GraphQLFormattedError<Record<string, any>>)

OptionalformatResponse

formatResponse?: ((response: GraphQLResponse, requestContext: GraphQLRequestContext<object>) => GraphQLResponse)

Optionalgateway

gateway?: GraphQLService

Optionalintrospection

introspection?: boolean

Optionallogger

logger?: Logger

OptionalmockEntireSchema

mockEntireSchema?: boolean

Optionalmocks

mocks?: boolean | IMocks

Optionalmodules

modules?: GraphQLSchemaModule[]

OptionalparseOptions

parseOptions?: GraphQLParseOptions

path

path: string

OptionalpersistedQueries

persistedQueries?: false | PersistedQueryOptions

Optionalplayground

playground?: PlaygroundConfig

Optionalplugins

plugins?: PluginDefinition[]

Optionalresolvers

resolvers?: IResolvers<any, any> | IResolvers<any, any>[]

OptionalrootValue

rootValue?: any

Optionalschema

schema?: GraphQLSchema

OptionalschemaDirectives

schemaDirectives?: Record<string, typeof SchemaDirectiveVisitor>

OptionalstopOnTerminationSignals

stopOnTerminationSignals?: boolean

Optionalsubscriptions

subscriptions?: string | false | Partial<SubscriptionServerOptions>

Optionaltracing

tracing?: boolean

OptionaltypeDefs

typeDefs?:
    | string
    | string[]
    | DocumentNode
    | DocumentNode[]

Optionaluploads

uploads?: boolean | FileUploadOptions

OptionalvalidationRules

validationRules?: ((context: ValidationContext) => any)[]

Settings

Member Visibility

On This Page

Properties