@vnodes/graphql
    Preparing search index...

    Interface ApolloDriverConfig

    interface ApolloDriverConfig {
        __testing_incrementalExecutionResults?:
            | GraphQLExperimentalIncrementalExecutionResultsAlpha2<
                ObjMap<unknown>,
                ObjMap<unknown>,
            >
            | GraphQLExperimentalIncrementalExecutionResultsAlpha9<
                ObjMap<unknown>,
                unknown,
                ObjMap<unknown>,
            >;
        allowBatchedHttpRequests?: boolean;
        apollo?: ApolloConfigInput;
        autoSchemaFile?: AutoSchemaFileValue;
        autoTransformHttpErrors?: boolean;
        buildSchemaOptions?: BuildSchemaOptions;
        cache?: KeyValueCache<string, KeyValueCacheSetOptions> | "bounded";
        context?: any;
        csrfPrevention?: boolean | CSRFPreventionOptions;
        dangerouslyDisableValidation?: boolean;
        debug?: boolean;
        definitions?: { outputAs?: "class" | "interface"; path?: string } & DefinitionsGeneratorOptions;
        directiveResolvers?: any;
        documentStore?: DocumentStore | null;
        driver?: Type<any>;
        executionOptions?: { maxCoercionErrors?: number };
        fieldResolver?: GraphQLFieldResolver<any, any>;
        fieldResolverEnhancers?: Enhancer[];
        formatError?: (
            formattedError: GraphQLFormattedError,
            error: unknown,
        ) => GraphQLFormattedError;
        graphiql?: boolean | GraphiQLOptions;
        hideSchemaDetailsFromClientErrors?: boolean;
        include?: Function[];
        includeStacktraceInErrorResponses?: boolean;
        inheritResolversFromInterfaces?: boolean;
        installSubscriptionHandlers?: boolean;
        introspection?: boolean;
        legacyExperimentalExecuteIncrementally?: LegacyExperimentalExecuteIncrementally;
        logger?: Logger;
        maxRecursiveSelections?: number | boolean;
        metadata?: () => Promise<Record<string, any>>;
        nodeEnv?: string;
        parseOptions?: ParseOptions;
        path?: string;
        persistedQueries?: false | PersistedQueryOptions;
        playground?: boolean | RenderPageOptions;
        plugins?: ApolloServerPlugin<any>[];
        resolvers?: IResolvers | IResolvers[];
        resolverValidationOptions?: IResolverValidationOptions;
        rootValue?: unknown;
        schema?: GraphQLSchema;
        sortSchema?: boolean;
        status400ForVariableCoercionErrors?: boolean;
        stopOnApplicationShutdown?: boolean;
        stopOnTerminationSignals?: boolean;
        stringifyResult?: (
            value: FormattedExecutionResult,
        ) => string | Promise<string>;
        subscriptions?: SubscriptionConfig;
        transformAutoSchemaFile?: boolean;
        transformResolvers?: (
            resolvers: IResolvers | IResolvers[],
        ) =>
            | IResolvers
            | IResolvers[]
            | Promise<IResolvers>
            | Promise<IResolvers[]>;
        transformSchema?: (
            schema: GraphQLSchema,
        ) => GraphQLSchema | Promise<GraphQLSchema>;
        typeDefs?: string | string[];
        typePaths?: string[];
        useGlobalPrefix?: boolean;
        validationOptions?: { maxErrors?: number };
        validationRules?: ValidationRule[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    __testing_incrementalExecutionResults? allowBatchedHttpRequests? apollo? autoSchemaFile? autoTransformHttpErrors? buildSchemaOptions? cache? context? csrfPrevention? dangerouslyDisableValidation? debug? definitions? directiveResolvers? documentStore? driver? executionOptions? fieldResolver? fieldResolverEnhancers? formatError? graphiql? hideSchemaDetailsFromClientErrors? include? includeStacktraceInErrorResponses? inheritResolversFromInterfaces? installSubscriptionHandlers? introspection? legacyExperimentalExecuteIncrementally? logger? maxRecursiveSelections? metadata? nodeEnv? parseOptions? path? persistedQueries? playground? plugins? resolvers? resolverValidationOptions? rootValue? schema? sortSchema? status400ForVariableCoercionErrors? stopOnApplicationShutdown? stopOnTerminationSignals? stringifyResult? subscriptions? transformAutoSchemaFile? transformResolvers? transformSchema? typeDefs? typePaths? useGlobalPrefix? validationOptions? validationRules?

    Properties

    Optional__testing_incrementalExecutionResults

    __testing_incrementalExecutionResults?:
        | GraphQLExperimentalIncrementalExecutionResultsAlpha2<
            ObjMap<unknown>,
            ObjMap<unknown>,
        >
        | GraphQLExperimentalIncrementalExecutionResultsAlpha9<
            ObjMap<unknown>,
            unknown,
            ObjMap<unknown>,
        >
    allowBatchedHttpRequests?: boolean
    apollo?: ApolloConfigInput
    autoSchemaFile?: AutoSchemaFileValue

    If enabled, GraphQL schema will be generated automatically

    autoTransformHttpErrors?: boolean

    If enabled, will register a global interceptor that automatically maps "HttpException" class instances to corresponding Apollo errors.

    true
    buildSchemaOptions?: BuildSchemaOptions

    Options to be passed to the schema generator Only applicable if "autoSchemaFile" = true

    cache?: KeyValueCache<string, KeyValueCacheSetOptions> | "bounded"
    context?: any

    Context function

    csrfPrevention?: boolean | CSRFPreventionOptions
    dangerouslyDisableValidation?: boolean
    debug?: boolean

    If true, enables development mode helpers and logs messages of all severity levels If false, only warn- and error-level messages are logged.

    true
    definitions?: { outputAs?: "class" | "interface"; path?: string } & DefinitionsGeneratorOptions

    TypeScript definitions generator options

    directiveResolvers?: any

    Directive resolvers

    documentStore?: DocumentStore | null
    driver?: Type<any>

    GraphQL server adapter

    executionOptions?: { maxCoercionErrors?: number }

    Type Declaration

    • OptionalmaxCoercionErrors?: number

      Set the maximum number of errors allowed for coercing (defaults to 50).

    fieldResolver?: GraphQLFieldResolver<any, any>
    fieldResolverEnhancers?: Enhancer[]

    Enable/disable enhancers for @ResolveField()

    formatError?: (
        formattedError: GraphQLFormattedError,
        error: unknown,
    ) => GraphQLFormattedError
    graphiql?: boolean | GraphiQLOptions

    GraphiQL options, or a boolean to enable GraphiQL with default options.

    hideSchemaDetailsFromClientErrors?: boolean
    include?: Function[]

    An array of modules to scan when searching for resolvers

    includeStacktraceInErrorResponses?: boolean
    inheritResolversFromInterfaces?: boolean

    Inherit missing resolvers from their interface types defined in the resolvers object.

    installSubscriptionHandlers?: boolean

    If enabled, "subscriptions-transport-ws" will be automatically registered.

    introspection?: boolean

    If true, enables schema introspection by clients. Default is true unless NODE_ENV is set to production

    true
    legacyExperimentalExecuteIncrementally?: LegacyExperimentalExecuteIncrementally
    logger?: Logger
    maxRecursiveSelections?: number | boolean
    metadata?: () => Promise<Record<string, any>>

    Extra static metadata to be loaded into the specification

    nodeEnv?: string
    parseOptions?: ParseOptions
    path?: string

    Path to mount GraphQL API

    persistedQueries?: false | PersistedQueryOptions
    playground?: boolean | RenderPageOptions

    GraphQL playground options. The built-in playground is deprecated and will be replaced with GraphiQL in the future.

    plugins?: ApolloServerPlugin<any>[]
    resolvers?: IResolvers | IResolvers[]

    Extra resolvers to be registered.

    resolverValidationOptions?: IResolverValidationOptions

    Resolver validation options.

    rootValue?: unknown
    schema?: GraphQLSchema

    Optional GraphQL schema (to be used or to be merged)

    sortSchema?: boolean

    Sort the schema lexicographically

    status400ForVariableCoercionErrors?: boolean
    stopOnApplicationShutdown?: boolean

    If true, the GraphQL server will stop during onApplicationShutdown instead of onModuleDestroy. This allows the server to keep accepting requests during beforeApplicationShutdown, enabling graceful shutdown.

    false
    stopOnTerminationSignals?: boolean
    stringifyResult?: (value: FormattedExecutionResult) => string | Promise<string>
    subscriptions?: SubscriptionConfig

    Subscriptions configuration.

    transformAutoSchemaFile?: boolean

    Apply transformSchema to the autoSchemaFile

    transformResolvers?: (
        resolvers: IResolvers | IResolvers[],
    ) => IResolvers | IResolvers[] | Promise<IResolvers> | Promise<IResolvers[]>

    Function to be applied to the discovered resolvers letting you perform compositions.

    transformSchema?: (
        schema: GraphQLSchema,
    ) => GraphQLSchema | Promise<GraphQLSchema>

    Function to be applied to the schema letting you register custom transformations.

    typeDefs?: string | string[]

    Type definitions

    typePaths?: string[]

    Paths to files that contain GraphQL definitions

    useGlobalPrefix?: boolean

    Prepends the global prefix to the url

    [faq/global-prefix](Global Prefix)

    validationOptions?: { maxErrors?: number }
    validationRules?: ValidationRule[]

    Settings

    Member Visibility

    On This Page

    Properties
    __testing_incrementalExecutionResultsallowBatchedHttpRequestsapolloautoSchemaFileautoTransformHttpErrorsbuildSchemaOptionscachecontextcsrfPreventiondangerouslyDisableValidationdebugdefinitionsdirectiveResolversdocumentStoredriverexecutionOptionsfieldResolverfieldResolverEnhancersformatErrorgraphiqlhideSchemaDetailsFromClientErrorsincludeincludeStacktraceInErrorResponsesinheritResolversFromInterfacesinstallSubscriptionHandlersintrospectionlegacyExperimentalExecuteIncrementallyloggermaxRecursiveSelectionsmetadatanodeEnvparseOptionspathpersistedQueriesplaygroundpluginsresolversresolverValidationOptionsrootValueschemasortSchemastatus400ForVariableCoercionErrorsstopOnApplicationShutdownstopOnTerminationSignalsstringifyResultsubscriptionstransformAutoSchemaFiletransformResolverstransformSchematypeDefstypePathsuseGlobalPrefixvalidationOptionsvalidationRules