Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SubscriptionClient

Index

Constructors

constructor

Properties

backoff

backoff: any

checkConnectionIntervalId

checkConnectionIntervalId: any

client

client: any

closedByUser

closedByUser: boolean

connectionCallback

connectionCallback: any

connectionParams

connectionParams: () => Promise<unknown>

Type declaration

    • (): Promise<unknown>
    • Returns Promise<unknown>

eventEmitter

eventEmitter: emit = emit

inactivityTimeout

inactivityTimeout: any

inactivityTimeoutId

inactivityTimeoutId: any

lazy

lazy: boolean

maxConnectTimeGenerator

maxConnectTimeGenerator: any

maxConnectTimeoutId

maxConnectTimeoutId: any

nextOperationId

nextOperationId: number

operations

operations: any

reconnect

reconnect: any

reconnecting

reconnecting: boolean

reconnectionAttempts

reconnectionAttempts: any

tryReconnectTimeoutId

tryReconnectTimeoutId: any

unsentMessagesQueue

unsentMessagesQueue: any[]

url

url: any

wasKeepAliveReceived

wasKeepAliveReceived: any

wsImpl

wsImpl: { constructor: any; CLOSED: number; CLOSING: number; CONNECTING: number; OPEN: number; prototype: WebSocket }

Type declaration

  • constructor: function
    • new __type(url: string, protocols?: string | string[]): WebSocket
    • Parameters

      • url: string
      • Optional protocols: string | string[]

      Returns WebSocket

  • Readonly CLOSED: number
  • Readonly CLOSING: number
  • Readonly CONNECTING: number
  • Readonly OPEN: number
  • prototype: WebSocket

wsTimeout

wsTimeout: any

Accessors

status

  • get status(): any

Methods

buildMessage

  • buildMessage(id: any, type: string, payload: { query: string; variables: Object }): { id: any; payload: { query: string; variables: Object }; type: string }
  • Parameters

    • id: any
    • type: string
    • payload: { query: string; variables: Object }
      • query: string
      • variables: Object

    Returns { id: any; payload: { query: string; variables: Object }; type: string }

    • id: any
    • payload: { query: string; variables: Object }
      • query: string
      • variables: Object
    • type: string

checkConnection

  • checkConnection(): void

checkMaxConnectTimeout

  • checkMaxConnectTimeout(): void

checkOperationOptions

  • checkOperationOptions(options: { operationName: any; query: any; variables: any }, handler: any): void
  • Parameters

    • options: { operationName: any; query: any; variables: any }
      • operationName: any
      • query: any
      • variables: any
    • handler: any

    Returns void

clearCheckConnectionInterval

  • clearCheckConnectionInterval(): void

clearInactivityTimeout

  • clearInactivityTimeout(): void

clearMaxConnectTimeout

  • clearMaxConnectTimeout(): void

clearTryReconnectTimeout

  • clearTryReconnectTimeout(): void

close

  • close(isForced?: boolean, closedByUser?: boolean): void
  • Parameters

    • Default value isForced: boolean = true
    • Default value closedByUser: boolean = true

    Returns void

connect

  • connect(): void

createMaxConnectTimeGenerator

  • createMaxConnectTimeGenerator(): any

executeOperation

  • executeOperation(options: any, handler: (arg0: any) => void): string
  • Parameters

    • options: any
    • handler: (arg0: any) => void
        • (arg0: any): void
        • Parameters

          • arg0: any

          Returns void

    Returns string

flushUnsentMessagesQueue

  • flushUnsentMessagesQueue(): void

formatErrors

  • formatErrors(errors: any): any

generateOperationId

  • generateOperationId(): string

getConnectionParams

  • getConnectionParams(connectionParams: unknown): (Anonymous function)

getObserver

  • getObserver(observerOrNext: any, error?: undefined | ((arg0: any) => any), complete?: undefined | (() => any)): any
  • Parameters

    • observerOrNext: any
    • Optional error: undefined | ((arg0: any) => any)
    • Optional complete: undefined | (() => any)

    Returns any

on

  • on(eventName: string, callback: any, context?: any): void
  • Parameters

    • eventName: string
    • callback: any
    • Optional context: any

    Returns void

onConnected

  • onConnected(callback: any, context?: any): void

onConnecting

  • onConnecting(callback: any, context?: any): void

onDisconnected

  • onDisconnected(callback: any, context?: any): void

onError

  • onError(callback: any, context?: any): void

onReconnected

  • onReconnected(callback: any, context?: any): void

onReconnecting

  • onReconnecting(callback: any, context?: any): void

processReceivedData

  • processReceivedData(receivedData: string): void

request

  • request(request: { query: any; variables?: undefined | object }): { __computed: any; subscribe: any }
  • Parameters

    • request: { query: any; variables?: undefined | object }
      • query: any
      • Optional variables?: undefined | object

    Returns { __computed: any; subscribe: any }

    • __computed: function
      • __computed()
    • subscribe: function
      • subscribe(observerOrNext?: any, onError?: any, onComplete?: any): { unsubscribe: any }
      • Parameters

        • Optional observerOrNext: any
        • Optional onError: any
        • Optional onComplete: any

        Returns { unsubscribe: any }

sendMessage

  • sendMessage(id: string | undefined, type: string, payload: any): void

sendMessageRaw

  • sendMessageRaw(message: { id: any; payload: any; type: any }): void
  • Parameters

    • message: { id: any; payload: any; type: any }
      • id: any
      • payload: any
      • type: any

    Returns void

setInactivityTimeout

  • setInactivityTimeout(): void

tryReconnect

  • tryReconnect(): void

unsubscribe

  • unsubscribe(opId: string): void

unsubscribeAll

  • unsubscribeAll(): void

Legend

  • Constructor
  • Property
  • Method

Generated using TypeDoc