Class ApolloServer<TContext>

constructor

• new ApolloServer<in out TContext extends BaseContext = BaseContext>(
      config: ApolloServerOptions<TContext>,
  ): ApolloServer<TContext>

  Type Parameters

  • in out TContext extends BaseContext = BaseContext

  Parameters

  • config: ApolloServerOptions<TContext>

  Returns ApolloServer<TContext>

Readonlycache

Readonlylogger

addPlugin

• addPlugin(plugin: ApolloServerPlugin<TContext>): void

  Parameters

  • plugin: ApolloServerPlugin<TContext>

  Returns void

assertStarted

• assertStarted(expressionForError: string): void

  Parameters

  • expressionForError: string

  Returns void

executeHTTPGraphQLRequest

• executeHTTPGraphQLRequest(
      __namedParameters: {
          context: ContextThunk<TContext>;
          httpGraphQLRequest: HTTPGraphQLRequest;
      },
  ): Promise<HTTPGraphQLResponse>

  Parameters

  • __namedParameters: { context: ContextThunk<TContext>; httpGraphQLRequest: HTTPGraphQLRequest }

  Returns Promise<HTTPGraphQLResponse>

executeOperation

• executeOperation<
      TData = Record<string, unknown>,
      TVariables extends VariableValues = VariableValues,
  >(
      this: ApolloServer<BaseContext>,
      request: Omit<GraphQLRequest<TVariables>, "query"> & {
          query?:
              | string
              | DocumentNode
              | TypedQueryDocumentNode<TData, TVariables>;
      },
  ): Promise<GraphQLResponse<TData>>

  Type Parameters

  • TData = Record<string, unknown>
  • TVariables extends VariableValues = VariableValues

  Parameters

  • this: ApolloServer<BaseContext>
  • request: Omit<GraphQLRequest<TVariables>, "query"> & {
        query?:
            | string
            | DocumentNode
            | TypedQueryDocumentNode<TData, TVariables>;
    }

  Returns Promise<GraphQLResponse<TData>>

• executeOperation<
      TData = Record<string, unknown>,
      TVariables extends VariableValues = VariableValues,
  >(
      request: Omit<GraphQLRequest<TVariables>, "query"> & {
          query?:
              | string
              | DocumentNode
              | TypedQueryDocumentNode<TData, TVariables>;
      },
      options?: ExecuteOperationOptions<TContext>,
  ): Promise<GraphQLResponse<TData>>

  Type Parameters

  • TData = Record<string, unknown>
  • TVariables extends VariableValues = VariableValues

  Parameters

  • request: Omit<GraphQLRequest<TVariables>, "query"> & {
        query?:
            | string
            | DocumentNode
            | TypedQueryDocumentNode<TData, TVariables>;
    }
  • Optionaloptions: ExecuteOperationOptions<TContext>

  Returns Promise<GraphQLResponse<TData>>

start

• start(): Promise<void>

  Returns Promise<void>

startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests

• startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests(): void

  Returns void

stop

• stop(): Promise<void>

  Returns Promise<void>