@vnodes/graphql
    Preparing search index...

    Interface GqlModuleOptions<TDriver>

    "GraphQLModule" options object.

    interface GqlModuleOptions<TDriver extends GraphQLDriver = any> {
        autoSchemaFile?: AutoSchemaFileValue;
        buildSchemaOptions?: BuildSchemaOptions;
        context?: any;
        debug?: boolean;
        definitions?: { outputAs?: "class" | "interface"; path?: string } & DefinitionsGeneratorOptions;
        directiveResolvers?: any;
        driver?: Type<TDriver>;
        fieldResolverEnhancers?: Enhancer[];
        include?: Function[];
        inheritResolversFromInterfaces?: boolean;
        introspection?: boolean;
        metadata?: () => Promise<Record<string, any>>;
        path?: string;
        resolvers?: IResolvers | IResolvers[];
        resolverValidationOptions?: IResolverValidationOptions;
        schema?: GraphQLSchema;
        sortSchema?: boolean;
        stopOnApplicationShutdown?: boolean;
        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;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    autoSchemaFile? buildSchemaOptions? context? debug? definitions? directiveResolvers? driver? fieldResolverEnhancers? include? inheritResolversFromInterfaces? introspection? metadata? path? resolvers? resolverValidationOptions? schema? sortSchema? stopOnApplicationShutdown? transformAutoSchemaFile? transformResolvers? transformSchema? typeDefs? typePaths? useGlobalPrefix?

    Properties

    autoSchemaFile?: AutoSchemaFileValue

    If enabled, GraphQL schema will be generated automatically

    buildSchemaOptions?: BuildSchemaOptions

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

    context?: any

    Context function

    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

    driver?: Type<TDriver>

    GraphQL server adapter

    fieldResolverEnhancers?: Enhancer[]

    Enable/disable enhancers for @ResolveField()

    include?: Function[]

    An array of modules to scan when searching for resolvers

    inheritResolversFromInterfaces?: boolean

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

    introspection?: boolean

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

    true
    metadata?: () => Promise<Record<string, any>>

    Extra static metadata to be loaded into the specification

    path?: string

    Path to mount GraphQL API

    resolvers?: IResolvers | IResolvers[]

    Extra resolvers to be registered.

    resolverValidationOptions?: IResolverValidationOptions

    Resolver validation options.

    schema?: GraphQLSchema

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

    sortSchema?: boolean

    Sort the schema lexicographically

    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
    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)

    Settings

    Member Visibility

    On This Page

    Properties