Class Transport

Hierarchy

  • Transport

Constructors

constructor

Properties

_isSniffing _nextSniff _sniffEnabled compression connectionPool emit maxRetries opaqueIdPrefix requestTimeout serializer sniffEndpoint sniffInterval sniffOnConnectionFault suggestCompression sniffReasons

Methods

getConnection request sniff

Constructors

constructor

  • Parameters

    • opts: TransportOptions

    Returns Transport

Properties

_isSniffing

_isSniffing: boolean

_nextSniff

_nextSniff: number

_sniffEnabled

_sniffEnabled: boolean

compression

compression: false | "gzip"

connectionPool

connectionPool: ConnectionPool | CloudConnectionPool

emit

emit: ((event: string | symbol, ...args: any[]) => boolean)

Type declaration

    • (event: string | symbol, ...args: any[]): boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

maxRetries

maxRetries: number

opaqueIdPrefix

opaqueIdPrefix: string

requestTimeout

requestTimeout: number

serializer

serializer: Serializer

sniffEndpoint

sniffEndpoint: string

sniffInterval

sniffInterval: number

sniffOnConnectionFault

sniffOnConnectionFault: boolean

suggestCompression

suggestCompression: boolean

Static sniffReasons

sniffReasons: { DEFAULT: string; SNIFF_INTERVAL: string; SNIFF_ON_CONNECTION_FAULT: string; SNIFF_ON_START: string }

Type declaration

  • DEFAULT: string
  • SNIFF_INTERVAL: string
  • SNIFF_ON_CONNECTION_FAULT: string
  • SNIFF_ON_START: string

Methods

getConnection

  • Parameters

    • opts: TransportGetConnectionOptions

    Returns Connection

request

  • Parameters

    • params: TransportRequestParams
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<Record<string, any>, Record<string, unknown>>>

  • Parameters

    • params: TransportRequestParams
    • Optional options: TransportRequestOptions
    • Optional callback: ((err: ApiError, result: ApiResponse<Record<string, any>, Record<string, unknown>>) => void)
        • (err: ApiError, result: ApiResponse<Record<string, any>, Record<string, unknown>>): void

        • Parameters

          Returns void

    Returns TransportRequestCallback

sniff

  • Parameters

    • Optional opts: TransportSniffOptions
    • Optional callback: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc