Class GraphQLServerWebSocket

constructor

• new GraphQLServerWebSocket(options): GraphQLServerWebSocket

• Parameters

  • options: GraphQLServerWebSocketOptions

  Returns GraphQLServerWebSocket

ReadonlyconnectionInitWaitTimeout

Readonlyreq

Readonlysocket

close

• close(code, reason): void

• Parameters

  • code: number
  • reason: string

  Returns void

closeByError

• closeByError(err): void

• Parameters

  • err: Error & {
        code?: number;
    }

  Returns void

handleCloseEvent

• handleCloseEvent(event): Promise<void>

• Parameters

  • event: CloseEvent

  Returns Promise<void>

handleCompleteMessage

• handleCompleteMessage(message): Promise<void>

• Parameters

  • message: CompleteMessage

  Returns Promise<void>

handleConnectionInitMessage

• handleConnectionInitMessage(message): Promise<void>

• Parameters

  • message: ConnectionInitMessage

  Returns Promise<void>

handleErrorEvent

• handleErrorEvent(event): Promise<void>

• Parameters

  • event: ErrorEvent

  Returns Promise<void>

handleMessageEvent

• handleMessageEvent(event): Promise<void>

• Parameters

  • event: MessageEvent<any>

  Returns Promise<void>

handleSubscribeMessage

• handleSubscribeMessage(message): Promise<void>

• Parameters

  • message: SubscribeMessage

  Returns Promise<void>

isOpen

• isOpen(): boolean

• Returns boolean

makeClosingError

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

• Parameters

  • code: number
  • reason: string

  Returns Error & {
      code: number;
  }

parseCompleteMessage

• parseCompleteMessage(message): CompleteMessage

• Parameters

  • message: Record<string, unknown>

  Returns CompleteMessage

parseConnectionInitMessage

• parseConnectionInitMessage(message): ConnectionInitMessage

• Parameters

  • message: Record<string, unknown>

  Returns ConnectionInitMessage

parseSubscribeMessage

• parseSubscribeMessage(message): 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): Promise<AsyncIterableIterator<ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>>>

• Parameters

  • id: string

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

send

• send(message): void

• Parameters

  • message: GraphQLWebSocketServerMessage

  Returns void