Class WebsocketTransport

Hierarchy

BaseTransport<WebsocketEvents>
- WebsocketTransport

Index

Constructors

Properties

Accessors

connected reconnectAttempts

Methods

_onmessage _send close emit notification off on once request

Constructors

constructor

new WebsocketTransport(url: string, options?: WebsocketOptions): WebsocketTransport
Parameters
- url: string
- Optional options: WebsocketOptions
Returns WebsocketTransport
Overrides BaseTransport.constructor
- Defined in node_modules/yerpc/dist/websocket.d.ts:22

Properties

_socket

_socket: ReconnectingWebsocket

e

e: Map<keyof WebsocketEvents, EventData[]>

url

url: string

Accessors

connected

get connected(): boolean
Returns boolean
- Defined in node_modules/yerpc/dist/websocket.d.ts:21

reconnectAttempts

get reconnectAttempts(): number
Returns number
- Defined in node_modules/yerpc/dist/websocket.d.ts:20

Methods

`Protected` _onmessage

_onmessage(message: yerpc.Message): void
Parameters
- message: yerpc.Message
Returns void
Inherited from BaseTransport._onmessage
- Defined in node_modules/yerpc/dist/client.d.ts:15

_send

_send(message: yerpc.Message): void
Parameters
- message: yerpc.Message
Returns void
Overrides BaseTransport._send
- Defined in node_modules/yerpc/dist/websocket.d.ts:23

close

close(): void
Returns void
Overrides BaseTransport.close
- Defined in node_modules/yerpc/dist/websocket.d.ts:24

emit

emit<E>(event: string | E, ...args: any[] | Arguments<ClientEvents<WebsocketEvents>[E]>): undefined | WebsocketTransport
Type Parameters
- E extends keyof WebsocketEvents
Parameters
- event: string | E
- Rest ...args: any[] | Arguments<ClientEvents<WebsocketEvents>[E]>
Returns undefined | WebsocketTransport
Inherited from BaseTransport.emit
- Defined in node_modules/yerpc/dist/util/emitter.d.ts:14

notification

notification(method: string, params?: yerpc.Params): void
Parameters
- method: string
- Optional params: yerpc.Params
Returns void
Inherited from BaseTransport.notification
- Defined in node_modules/yerpc/dist/client.d.ts:16

off

off<E>(event: E, callback?: ClientEvents<WebsocketEvents>[E]): undefined | WebsocketTransport
Type Parameters
- E extends keyof WebsocketEvents
Parameters
- event: E
- Optional callback: ClientEvents<WebsocketEvents>[E]
Returns undefined | WebsocketTransport
Inherited from BaseTransport.off
- Defined in node_modules/yerpc/dist/util/emitter.d.ts:15

on

on<E>(event: E, callback: ClientEvents<WebsocketEvents>[E], ctx?: any): WebsocketTransport
Type Parameters
- E extends keyof WebsocketEvents
Parameters
- event: E
- callback: ClientEvents<WebsocketEvents>[E]
- Optional ctx: any
Returns WebsocketTransport
Inherited from BaseTransport.on
- Defined in node_modules/yerpc/dist/util/emitter.d.ts:11

once

once<E>(event: E, callback: ClientEvents<WebsocketEvents>[E], ctx?: any): void
Type Parameters
- E extends keyof WebsocketEvents
Parameters
- event: E
- callback: ClientEvents<WebsocketEvents>[E]
- Optional ctx: any
Returns void
Inherited from BaseTransport.once
- Defined in node_modules/yerpc/dist/util/emitter.d.ts:13

request

request(method: string, params?: yerpc.Params): Promise<unknown>
Parameters
- method: string
- Optional params: yerpc.Params
Returns Promise<unknown>
Inherited from BaseTransport.request
- Defined in node_modules/yerpc/dist/client.d.ts:17

Generated using TypeDoc