Class GraphQLServerWebSocket

constructor

• new GraphQLServerWebSocket(
      options: GraphQLServerWebSocketOptions,
  ): GraphQLServerWebSocket

  Parameters

  • options: GraphQLServerWebSocketOptions

  Returns GraphQLServerWebSocket

ReadonlyconnectionInitWaitTimeout

Readonlyreq

Readonlysocket

close

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

  Parameters

  • code: number
  • reason: string

  Returns void

closeByError

• closeByError(err: Error & { code?: number }): void

  Parameters

  • err: Error & { code?: number }

  Returns void

handleCloseEvent

• handleCloseEvent(event: CloseEvent): Promise<void>

  Parameters

  • event: CloseEvent

  Returns Promise<void>

handleCompleteMessage

• handleCompleteMessage(message: CompleteMessage): Promise<void>

  Parameters

  • message: CompleteMessage

  Returns Promise<void>

handleConnectionInitMessage

• handleConnectionInitMessage(message: ConnectionInitMessage): Promise<void>

  Parameters

  • message: ConnectionInitMessage

  Returns Promise<void>

handleErrorEvent

• handleErrorEvent(event: ErrorEvent): Promise<void>

  Parameters

  • event: ErrorEvent

  Returns Promise<void>

handleMessageEvent

• handleMessageEvent(event: MessageEvent): Promise<void>

  Parameters

  • event: MessageEvent

  Returns Promise<void>

handleSubscribeMessage

• handleSubscribeMessage(message: SubscribeMessage): Promise<void>

  Parameters

  • message: SubscribeMessage

  Returns Promise<void>

isOpen

• isOpen(): boolean

  Returns boolean

makeClosingError

• makeClosingError(code: number, reason: string): Error & { code: number }

  Parameters

  • code: number
  • reason: string

  Returns Error & { code: number }

parseCompleteMessage

• parseCompleteMessage(message: Record<string, unknown>): CompleteMessage

  Parameters

  • message: Record<string, unknown>

  Returns CompleteMessage

parseConnectionInitMessage

• parseConnectionInitMessage(
      message: Record<string, unknown>,
  ): ConnectionInitMessage

  Parameters

  • message: Record<string, unknown>

  Returns ConnectionInitMessage

parseSubscribeMessage

• parseSubscribeMessage(message: Record<string, unknown>): SubscribeMessage

  Parameters

  • message: Record<string, unknown>

  Returns SubscribeMessage

requireAck

• requireAck(): Promise<undefined | null | Record<string, unknown>>

  Returns Promise<undefined | null | Record<string, unknown>>

requireSubscription

• requireSubscription(
      id: string,
  ): Promise<
      AsyncIterableIterator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          any,
          any,
      >,
  >

  Parameters

  • id: string

  Returns Promise<
      AsyncIterableIterator<
          ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>,
          any,
          any,
      >,
  >

send

• send(message: GraphQLWebSocketServerMessage): void

  Parameters

  • message: GraphQLWebSocketServerMessage

  Returns void