Class WebSocketTransport

Hierarchy

Transport
- WebSocketTransport

Index

Constructors

constructor

new WebSocketTransport(uri: string): WebSocketTransport
Parameters
- uri: string
Returns WebSocketTransport
Overrides Transport.constructor
- Defined in src/transports/WebSocketTransport.ts:18

Properties

connection

connection: WebSocket

`Protected`transportRequestManager

transportRequestManager: TransportRequestManager

uri

uri: string

Methods

close

close(): void
Returns void
Overrides Transport.close
- Defined in src/transports/WebSocketTransport.ts:72

connect

connect(): Promise<any>
Returns Promise<any>
Overrides Transport.connect
- Defined in src/transports/WebSocketTransport.ts:24

`Protected`parseData

parseData(
    data: JSONRPCRequestData,
):
    | IJSONRPCRequest
    | IJSONRPCNotification
    | (IJSONRPCRequest | IJSONRPCNotification)[]
Parameters
- data: JSONRPCRequestData
Returns
    | IJSONRPCRequest
    | IJSONRPCNotification
    | (IJSONRPCRequest | IJSONRPCNotification)[]
Inherited from Transport.parseData
- Defined in src/transports/Transport.ts:65

sendData

sendData(data: JSONRPCRequestData, timeout?: null | number): Promise<any>
Parameters
- data: JSONRPCRequestData
- timeout: null | number = 5000
Returns Promise<any>
Overrides Transport.sendData
- Defined in src/transports/WebSocketTransport.ts:39

subscribe(
    event: keyof ITransportEvents,
    handler:
        | ((data: JSONRPCError) => void)
        | ((data: JSONRPCRequestData) => void)
        | ((data: IJSONRPCNotificationResponse) => void)
        | ((data: IJSONRPCResponse) => void),
): void
Parameters
- event: keyof ITransportEvents
- handler:
      | ((data: JSONRPCError) => void)
      | ((data: JSONRPCRequestData) => void)
      | ((data: IJSONRPCNotificationResponse) => void)
      | ((data: IJSONRPCResponse) => void)
Returns void
Inherited from Transport.subscribe
- Defined in src/transports/Transport.ts:42

unsubscribe

unsubscribe(
    event?: keyof ITransportEvents,
    handler?:
        | ((data: JSONRPCError) => void)
        | ((data: JSONRPCRequestData) => void)
        | ((data: IJSONRPCNotificationResponse) => void)
        | ((data: IJSONRPCResponse) => void),
): undefined | EventEmitter<DefaultEventMap>
Parameters
- Optionalevent: keyof ITransportEvents
- Optionalhandler:
      | ((data: JSONRPCError) => void)
      | ((data: JSONRPCRequestData) => void)
      | ((data: IJSONRPCNotificationResponse) => void)
      | ((data: IJSONRPCResponse) => void)
Returns undefined | EventEmitter<DefaultEventMap>
Inherited from Transport.unsubscribe
- Defined in src/transports/Transport.ts:51

Class WebSocketTransport

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketTransport

Properties

connection

`Protected`transportRequestManager

uri

Methods

close

Returns void

connect

Returns Promise<any>

`Protected`parseData

Parameters

Returns
    | IJSONRPCRequest
    | IJSONRPCNotification
    | (IJSONRPCRequest | IJSONRPCNotification)[]

sendData

Parameters

Returns Promise<any>

Parameters

Returns void

unsubscribe

Parameters

Returns undefined | EventEmitter<DefaultEventMap>

Settings

On This Page

Class WebSocketTransport

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketTransport

Properties

connection

ProtectedtransportRequestManager

uri

Methods

close

Returns void

connect

Returns Promise<any>

ProtectedparseData

Parameters

Returns | IJSONRPCRequest | IJSONRPCNotification | (IJSONRPCRequest | IJSONRPCNotification)[]

sendData

Parameters

Returns Promise<any>

subscribe

Parameters

Returns void

unsubscribe

Parameters

Returns undefined | EventEmitter<DefaultEventMap>

Settings

On This Page

`Protected`transportRequestManager

`Protected`parseData

Returns
| IJSONRPCRequest
| IJSONRPCNotification
| (IJSONRPCRequest | IJSONRPCNotification)[]