Class GraphQLClientWebSocket

constructor

• new GraphQLClientWebSocket(
      options: GraphQLClientWebSocketOptions,
  ): GraphQLClientWebSocket

  Parameters

  • options: GraphQLClientWebSocketOptions

  Returns GraphQLClientWebSocket

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): void

  Parameters

  • message: CompleteMessage

  Returns void

handleConnectionAckMessage

• handleConnectionAckMessage(message: ConnectionAckMessage): void

  Parameters

  • message: ConnectionAckMessage

  Returns void

handleErrorEvent

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

  Parameters

  • event: Event

  Returns Promise<void>

handleErrorMessage

• handleErrorMessage(message: ErrorMessage): void

  Parameters

  • message: ErrorMessage

  Returns void

handleMessageEvent

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

  Parameters

  • event: MessageEvent

  Returns Promise<void>

handleNextMessage

• handleNextMessage(message: NextMessage): void

  Parameters

  • message: NextMessage

  Returns void

init

• init(connectionInitPayload?: Record<string, unknown>): GraphQLClientWebSocket

  Parameters

  • OptionalconnectionInitPayload: Record<string, unknown>

  Returns GraphQLClientWebSocket

isOpen

• isOpen(): boolean

  Returns boolean

isOpenOrConnecting

• isOpenOrConnecting(): 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

parseConnectionAckMessage

• parseConnectionAckMessage(
      message: Record<string, unknown>,
  ): ConnectionAckMessage

  Parameters

  • message: Record<string, unknown>

  Returns ConnectionAckMessage

parseErrorMessage

• parseErrorMessage(message: Record<string, unknown>): ErrorMessage

  Parameters

  • message: Record<string, unknown>

  Returns ErrorMessage

parseNextMessage

• parseNextMessage(message: Record<string, unknown>): NextMessage

  Parameters

  • message: Record<string, unknown>

  Returns NextMessage

requireAck

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

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

requireSubscription

• requireSubscription(id: string): AsyncPushIterator<any>

  Parameters

  • id: string

  Returns AsyncPushIterator<any>

send

• send(message: GraphQLWebSocketClientMessage): void

  Parameters

  • message: GraphQLWebSocketClientMessage

  Returns void

subscribe

• subscribe<TData>(
      payload: {
          operationName?: null | string;
          query: string;
          variables?: null | Record<string, unknown>;
      },
  ): AsyncPushIterator<ExecutionResult<TData, ObjMap<unknown>>>

  Type Parameters

  • TData

  Parameters

  • payload: {
        operationName?: null | string;
        query: string;
        variables?: null | Record<string, unknown>;
    }

  Returns AsyncPushIterator<ExecutionResult<TData, ObjMap<unknown>>>