Class BaseChannel`Abstract`

Hierarchy

BaseChannel
- IPCChannel
- IPCChannel

Index

Constructors

Properties

_logger _requestId endpointHandlers endpointsList eventsList namespace

Methods

_getNextRequestId invoke isValidActionName isValidEventName once publish registerToBus subscribe unsubscribe

Constructors

constructor

new BaseChannel(logger: Logger, namespace: string, events: readonly string[], endpoints: EndpointHandlers): BaseChannel
Parameters
- logger: Logger
- namespace: string
- events: readonly string[]
- endpoints: EndpointHandlers
Returns BaseChannel
- Defined in framework/src/controller/channels/base_channel.ts:37

Properties

`Protected` `Readonly` _logger

_logger: Logger

`Private` _requestId

_requestId: number

`Protected` `Readonly` endpointHandlers

endpointHandlers: EndpointHandlers

`Readonly` endpointsList

endpointsList: readonly string[]

`Readonly` eventsList

eventsList: readonly string[]

`Readonly` namespace

namespace: string

Methods

`Protected` _getNextRequestId

_getNextRequestId(): string
Returns string
- Defined in framework/src/controller/channels/base_channel.ts:75

`Abstract` invoke

invoke<T>(req: InvokeRequest): Promise<T>
Type Parameters
- T
Parameters
- req: InvokeRequest
Returns Promise<T>
- Defined in framework/src/controller/channels/base_channel.ts:93

isValidActionName

isValidActionName(name: string, throwError?: boolean): boolean
Parameters
- name: string
- throwError: boolean = true
Returns boolean
- Defined in framework/src/controller/channels/base_channel.ts:65

isValidEventName

isValidEventName(name: string, throwError?: boolean): boolean
Parameters
- name: string
- throwError: boolean = true
Returns boolean
- Defined in framework/src/controller/channels/base_channel.ts:56

`Abstract` once

once(eventName: string, cb: EventCallback): void
Parameters
- eventName: string
- cb: EventCallback
Returns void
- Defined in framework/src/controller/channels/base_channel.ts:96

`Abstract` publish

publish(eventName: string, data?: Record<string, unknown>): void
Parameters
- eventName: string
- Optional data: Record<string, unknown>
Returns void
- Defined in framework/src/controller/channels/base_channel.ts:89

`Abstract` registerToBus

registerToBus(arg: unknown): Promise<void>
Parameters
- arg: unknown
Returns Promise<void>
- Defined in framework/src/controller/channels/base_channel.ts:95

`Abstract` subscribe

subscribe(eventName: string, cb: EventCallback): void
Parameters
- eventName: string
- cb: EventCallback
Returns void
- Defined in framework/src/controller/channels/base_channel.ts:83

`Abstract` unsubscribe

unsubscribe(eventName: string, cb: EventCallback): void
Parameters
- eventName: string
- cb: EventCallback
Returns void
- Defined in framework/src/controller/channels/base_channel.ts:84

Generated using TypeDoc