Class GraphQLWebSocketServer<TContext>

constructor

• new GraphQLWebSocketServer<TContext>(
      options: GraphQLWebSocketServerOptions<TContext>,
  ): GraphQLWebSocketServer<TContext>

  Type Parameters

  • TContext

  Parameters

  • options: GraphQLWebSocketServerOptions<TContext>

  Returns GraphQLWebSocketServer<TContext>

ReadonlygraphqlSockets

Readonlyparser

Readonlyschema

close

• close(code?: number, reason?: string): void

  Parameters

  • Optionalcode: number
  • Optionalreason: string

  Returns void

connectionHandler

• connectionHandler(): (
      socket: WebSocket,
      req: IncomingMessage,
  ) => GraphQLServerWebSocket

  Returns (socket: WebSocket, req: IncomingMessage) => GraphQLServerWebSocket

handleConnection

• handleConnection(
      socket: WebSocket,
      req: IncomingMessage,
  ): GraphQLServerWebSocket

  Parameters

  • socket: WebSocket
  • req: IncomingMessage

  Returns GraphQLServerWebSocket

parse

• parse(request: RawExecutionArgs): ParsedExecutionArgs

  Parameters

  • request: RawExecutionArgs

  Returns ParsedExecutionArgs

serializeError

• serializeError(err: unknown): GraphQLError

  Parameters

  • err: unknown

  Returns GraphQLError

subscribe

• subscribe(
      args: RawExecutionArgs,
      connectionInitPayload?: null | Record<string, unknown>,
  ): Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

  Parameters

  • args: RawExecutionArgs
  • OptionalconnectionInitPayload: null | Record<string, unknown>

  Returns Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

subscribeParsed

• subscribeParsed(
      args: ParsedExecutionArgs,
      connectionInitPayload?: null | Record<string, unknown>,
  ): Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

  Parameters

  • args: ParsedExecutionArgs
  • OptionalconnectionInitPayload: null | Record<string, unknown>

  Returns Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

subscribeValidated

• subscribeValidated(
      args: ParsedExecutionArgs,
      connectionInitPayload: undefined | null | Record<string, unknown>,
  ): Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

  Parameters

  • args: ParsedExecutionArgs
  • connectionInitPayload: undefined | null | Record<string, unknown>

  Returns Promise<
      | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
      | AsyncGenerator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          void,
          void,
      >,
  >

validate

• validate(args: ParsedExecutionArgs): GraphQLError[]

  Parameters

  • args: ParsedExecutionArgs

  Returns GraphQLError[]