Class BaseTransport<T>`Abstract`

Type Parameters

T = {}

Hierarchy

Emitter<ClientEvents<T>>
- BaseTransport
  - WebsocketTransport
  - StdioTransport

Implements

Transport

Index

Constructors

Properties

_requestId _requests e

Methods

_onmessage _send close emit notification off on once request

Constructors

constructor

new BaseTransport<T>(): BaseTransport<T>
Type Parameters
- T = {}
Returns BaseTransport<T>
Inherited from Emitter<ClientEvents<T>>.constructor
- Defined in node_modules/yerpc/dist/util/emitter.d.ts:10

Properties

`Private` _requestId

_requestId: any

`Private` _requests

_requests: any

e

e: Map<"request" | keyof T, EventData[]>

Methods

`Protected` _onmessage

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

_send

_send(_message: yerpc.Message): void
Parameters
- _message: yerpc.Message
Returns void
- Defined in node_modules/yerpc/dist/client.d.ts:13

close

close(): void
Returns void
- Defined in node_modules/yerpc/dist/client.d.ts:14

emit

emit<E>(event: string | E, ...args: any[] | Arguments<ClientEvents<T>[E]>): undefined | BaseTransport<T>
Type Parameters
- E extends string | number | symbol
Parameters
- event: string | E
- Rest ...args: any[] | Arguments<ClientEvents<T>[E]>
Returns undefined | BaseTransport<T>
Inherited from Emitter.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
Implementation of Transport.notification
- Defined in node_modules/yerpc/dist/client.d.ts:16

off

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

on

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

once

once<E>(event: E, callback: ClientEvents<T>[E], ctx?: any): void
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- callback: ClientEvents<T>[E]
- Optional ctx: any
Returns void
Inherited from Emitter.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>
Implementation of Transport.request
- Defined in node_modules/yerpc/dist/client.d.ts:17

Generated using TypeDoc