kumo-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Connection

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Connection(url: string, protocols?: string | string[], origin?: string, headers?: OutgoingHttpHeaders, requestOptions?: object, IClientConfig?: IClientConfig): Connection

  • Parameters

    • url: string
    • Optional protocols: string | string[]
    • Optional origin: string
    • Optional headers: OutgoingHttpHeaders
    • Optional requestOptions: object
    • Optional IClientConfig: IClientConfig

    Returns Connection

Properties

CLOSED

CLOSED: number

CLOSING

CLOSING: number

CONNECTING

CONNECTING: number

OPEN

OPEN: number

_binaryType

_binaryType: "arraybuffer"

_bufferedAmount

_bufferedAmount: number

_client

_client: client

Optional _connection

_connection: connection

_extensions

_extensions: IExtension[]

Optional _protocol

_protocol: string

_readyState

_readyState: number

_url

_url: string

binaryType

binaryType: "arraybuffer"

bufferedAmount

bufferedAmount: number

extensions

extensions: IExtension[]

onclose

onclose: function

Type declaration

    • (event: ICloseEvent): void

    • Parameters

      • event: ICloseEvent

      Returns void

onerror

onerror: function

Type declaration

    • (error: Error): void

    • Parameters

      • error: Error

      Returns void

onmessage

onmessage: function

Type declaration

    • (message: IMessageEvent): void

    • Parameters

      • message: IMessageEvent

      Returns void

onopen

onopen: function

Type declaration

    • (): void

    • Returns void

Optional protocol

protocol: string

readyState

readyState: number

url

url: string

Static CLOSED

CLOSED: number

Static CLOSING

CLOSING: number

Static CONNECTING

CONNECTING: number

Static OPEN

OPEN: number

Methods

close

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

  • Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

send

  • send(data: ArrayBufferView | ArrayBuffer | Buffer | IStringified): void

  • Parameters

    • data: ArrayBufferView | ArrayBuffer | Buffer | IStringified

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc