Class GraphqlService

GraphQL service implementation.

Implements

IGraphqlService

Index

Constructors

Accessors

cachedDocumentCount endpoint

Methods

clearCache execute subscribe

Constructors

constructor

new GraphqlService(
    runtime: GraphqlRuntime,
    schema: GraphqlSchemaLike,
    options: {
        buildContext?: (input: GraphqlContextInput) => unknown;
        documentCacheSize: number;
        endpoint: string;
        formatError?: (error: unknown) => unknown;
        introspection: boolean;
        logger?: GraphqlLogger;
        maskInternalErrors: boolean;
        maxDepth: number;
        maxNodes?: number;
        rootValue?: unknown;
        serviceRegistry: IServiceRegistry;
        validationRules?: unknown[];
    },
): GraphqlService
Parameters
- runtime: GraphqlRuntime
- schema: GraphqlSchemaLike
- options: {
      buildContext?: (input: GraphqlContextInput) => unknown;
      documentCacheSize: number;
      endpoint: string;
      formatError?: (error: unknown) => unknown;
      introspection: boolean;
      logger?: GraphqlLogger;
      maskInternalErrors: boolean;
      maxDepth: number;
      maxNodes?: number;
      rootValue?: unknown;
      serviceRegistry: IServiceRegistry;
      validationRules?: unknown[];
  }
  - OptionalbuildContext?: (input: GraphqlContextInput) => unknown
  - documentCacheSize: number
  - endpoint: string
  - OptionalformatError?: (error: unknown) => unknown
  - introspection: boolean
  - Optionallogger?: GraphqlLogger
    
    Sink for masked internal errors. Supplied by the plugin from IPluginContext.logger; IRequestContext carries no logger, so this is the only path by which a masked error reaches an operator.
  - maskInternalErrors: boolean
  - maxDepth: number
  - OptionalmaxNodes?: number
    
    Field budget; 0 or omitted disables the rule. Optional rather than required because the plugin option it mirrors defaults to off, so a caller constructing this service directly should not have to opt out.
  - OptionalrootValue?: unknown
  - serviceRegistry: IServiceRegistry
    
    Plugin-level registry (for WS subscription context).
  - OptionalvalidationRules?: unknown[]
Returns GraphqlService
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:109

Accessors

cachedDocumentCount

get cachedDocumentCount(): number
Report the number of cached documents.

Returns number
Implementation of IGraphqlService.cachedDocumentCount
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:180

endpoint

get endpoint(): string
The endpoint path where GraphQL is served.

Returns string
Implementation of IGraphqlService.endpoint
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:176

Methods

clearCache

clearCache(): void
Clear the document cache.

Returns void
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:388

execute

execute(
    params: GraphqlRequestParams,
    requestContext?: IRequestContext,
    method?: "GET" | "POST",
): Promise<GraphqlExecutionOutcome>
Execute a GraphQL request.
Parameters
- params: GraphqlRequestParams
  The parsed GraphQL request parameters
- OptionalrequestContext: IRequestContext
  Optional request context for service resolution
- Optionalmethod: "GET" | "POST"
  Optional HTTP method (used for operation-kind guard)
Returns Promise<GraphqlExecutionOutcome>
The execution outcome with HTTP status
Implementation of IGraphqlService.execute
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:208

subscribe(
params: GraphqlRequestParams,
context?: GraphqlOperationContext,
): Promise<GraphqlSubscriptionOutcome>
Subscribe to a GraphQL operation (query, mutation, or subscription).

Accepts every operation kind and returns the matching discriminated outcome. The transports narrow on the kind field to emit conformant frames.
Parameters
- params: GraphqlRequestParams
  The parsed GraphQL request parameters
- Optionalcontext: GraphqlOperationContext
  Optional operation context (request or connection)
Returns Promise<GraphqlSubscriptionOutcome>
The discriminated subscription outcome

Since
0.3.0
Implementation of IGraphqlService.subscribe
- Defined in packages/graphql-plugin/src/services/graphql-service.ts:267