Interface GraphQLServerBootstrapOptions<TContext>

interface GraphQLServerBootstrapOptions<TContext> {
    acknowledge?: AcknowledgeFn;
    connectionInitWaitTimeout?: number;
    createContext: CreateContextFn<TContext>;
    defaultFieldResolver?: GraphQLFieldResolver<unknown, TContext>;
    http?: GraphQLHttpServer<TContext>;
    parser?: GraphQLExecutionArgsParser;
    parserOptions?: GraphQLExecutionArgsParserOptions;
    reader?: GraphQLReader;
    resolverErrorHandler?: ResolverErrorHandler<TContext>;
    resolvers?: ResolversInput<TContext>;
    root?: string;
    schema?: string | GraphQLSchema;
    stitching?: boolean;
    ws?: GraphQLWebSocketServer<TContext>;
}

Type Parameters

  • TContext

Hierarchy

Properties

acknowledge? connectionInitWaitTimeout? createContext defaultFieldResolver? http? parser? parserOptions? reader? resolverErrorHandler? resolvers? root? schema? stitching? ws?

Properties

Optionalacknowledge

acknowledge?: AcknowledgeFn

Acknowledgement function. Called once per connection with the initialization message payload. May throw an error to cause socket closure (4401 Unauthorized).

OptionalconnectionInitWaitTimeout

connectionInitWaitTimeout?: number

Timeout until receiving initialization message, in milliseconds. Defaults to 3000.

createContext

createContext: CreateContextFn<TContext>

Function to create context from HTTP headers.

OptionaldefaultFieldResolver

defaultFieldResolver?: GraphQLFieldResolver<unknown, TContext>

Default field resolver.

Optionalhttp

http?: GraphQLHttpServer<TContext>

Optionalparser

parser?: GraphQLExecutionArgsParser

Overrides execution args parser.

OptionalparserOptions

parserOptions?: GraphQLExecutionArgsParserOptions

Execution args parser options.

Optionalreader

reader?: GraphQLReader

GraphQLReader instance.

OptionalresolverErrorHandler

resolverErrorHandler?: ResolverErrorHandler<TContext>

Resolver error handler.

Optionalresolvers

resolvers?: ResolversInput<TContext>

Resolver definitions, or list of resolver definitions.

Optionalroot

root?: string

Path to root directory for code generation. It's recommended to use a root relative to __dirname. Defaults to the current working dir.

Optionalschema

schema?: string | GraphQLSchema

Path to directory of GraphQL schema documents, relative to root, OR a GraphQLSchema instance. Defaults to "schema".

Optionalstitching

stitching?: boolean

Optionalws

ws?: GraphQLWebSocketServer<TContext>

Settings

Member Visibility

On This Page

Properties