Class ResillientChannel

Channel that buffers if not connected. The actual channel can be removed and replaced.

Hierarchy (View Summary)

Channel
- ResillientChannel

Index

Constructors

constructor

new ResillientChannel(): ResillientChannel
Returns ResillientChannel
Inherited from Channel.constructor

Properties

_logEmitter

_logEmitter: LoggerInterface = ...

call

call: {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
} = ...

RPC like emitting of events.

context

context: ContextType = ...

dispose

dispose: (strictSync?: boolean) => void | Promise<any> & {
 add: (obj?: DisposableEntry) => DisposerFunction | undefined;
 dispose: (strictSync?: boolean) => void | Promise<any>;
 disposeSync: () => void;
 exec: (strictSync?: boolean) => void | Promise<any>;
 remove: (disposable: DisposableEntry) => void | Promise<void>;
 sync: () => void;
 track: (obj?: DisposableEntry) => DisposerFunction | undefined;
 untrack: (disposable: DisposableEntry) => void | Promise<void>;
 get disposed(): number;
 "[asyncDispose]"(): Promise<any>;
 "[dispose]"(): void | Promise<any>;
 getSize(): number;
 isDisposed(): boolean;
} & {
 interval: (fn: TimerExecFunction, interval?: number) => DisposerFunction;
 intervalPause: (
 fn: TimerExecFunction,
 interval?: number,
 ) => DisposerFunction;
 on: (
 emitter: any,
 eventName: string,
 fn: (ev?: any) => void,
 ...args: any[],
 ) => DisposerFunction;
 once: (
 emitter: any,
 eventName: string,
 fn: (ev?: any) => void,
 ...args: any[],
 ) => DisposerFunction;
 timeout: (fn: TimerExecFunction, timeout?: number) => DisposerFunction;
} = ...

Type Declaration

- (strictSync?: boolean): void | Promise<any>
- Dispose all tracked entries
 Parameters
 - strictSync: boolean = false
 Returns void | Promise<any>

add: (obj?: DisposableEntry) => DisposerFunction | undefined
dispose: (strictSync?: boolean) => void | Promise<any>
disposeSync: () => void
exec: (strictSync?: boolean) => void | Promise<any>
Deprecated
use dispose
remove: (disposable: DisposableEntry) => void | Promise<void>
sync: () => void
track: (obj?: DisposableEntry) => DisposerFunction | undefined
Deprecated
use add
untrack: (disposable: DisposableEntry) => void | Promise<void>
Deprecated
use remove
get disposed(): number
Counter that increments each time dispose has been called
[asyncDispose]: function
- "[asyncDispose]"(): Promise<any>
 Returns Promise<any>
 - Defined in common/dispose-defer.ts:135
[dispose]: function
- "[dispose]"(): void | Promise<any>
 Returns void | Promise<any>
 - Defined in common/dispose-defer.ts:131
getSize: function
- getSize(): number
  Returns number
  - Defined in common/dispose-defer.ts:124
isDisposed: function
- isDisposed(): boolean
  Returns boolean
  - Defined in common/dispose-defer.ts:127

interval: (fn: TimerExecFunction, interval?: number) => DisposerFunction
intervalPause: (fn: TimerExecFunction, interval?: number) => DisposerFunction
on: (
    emitter: any,
    eventName: string,
    fn: (ev?: any) => void,
    ...args: any[],
) => DisposerFunction
once: (
    emitter: any,
    eventName: string,
    fn: (ev?: any) => void,
    ...args: any[],
) => DisposerFunction
timeout: (fn: TimerExecFunction, timeout?: number) => DisposerFunction

id

id: string = ...

Accessors

isConnected

get isConnected(): boolean
Returns boolean
Overrides Channel.isConnected
- Defined in common/msg/channel-resilient.ts:70

Methods

addEventListener

addEventListener(
 event: U,
 fn: DefaultListener[U],
 opt?: EmitterSubscriberOptions,
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- fn: DefaultListener[U]
- opt: EmitterSubscriberOptions = {}
Returns DisposerFunction
Inherited from Channel.addEventListener
- Defined in common/msg/emitter.ts:202

close

close(): void
Returns void
Deprecated
use .dispose()
Inherited from Channel.close
- Defined in common/msg/channel.ts:35

deleteChannel

deleteChannel(): void
Returns void
Deprecated
use setChannel(undefined)
- Defined in common/msg/channel-resilient.ts:60

emit

emit(
 event: U,
 ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >,
): Promise<boolean>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "message" | "messageerror" | "connect" | "disconnect" | "close"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the event was successfully emitted.
Inherited from Channel.emit
- Defined in common/msg/emitter.ts:105

emptyBuffer

emptyBuffer(): void
Reset buffer without force sending

Returns void
- Defined in common/msg/channel-resilient.ts:39

flushBuffer

flushBuffer(): void
Post all buffered messages

Returns void
- Defined in common/msg/channel-resilient.ts:28

get

get(
 event: U,
 ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >,
): Promise<
 | ReturnType<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >
 | undefined,
>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "message" | "messageerror" | "connect" | "disconnect" | "close"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<
 | ReturnType<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >
 | undefined,
>
A promise that resolves to the result of the first subscriber's handler, or undefined if no subscribers are present.
Inherited from Channel.get
- Defined in common/msg/emitter.ts:90

getAll

getAll(
 event: U,
 ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >,
): Promise<
 | ReturnType<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >[]
 | undefined,
>
Emits an event to all subscribers and executes their corresponding event handlers.
Type Parameters
- U extends "message" | "messageerror" | "connect" | "disconnect" | "close"
Parameters
- event: U
 The event to emit.
- ...args: Parameters<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >
 The arguments to pass to the event handlers.
Returns Promise<
 | ReturnType<
 {
 close: () => void;
 connect: () => void;
 disconnect: () => void;
 message: (event: ChannelMessageEvent<any>) => void;
 messageerror: (event: ChannelMessageEvent<any>) => void;
 }[U],
 >[]
 | undefined,
>
A promise that resolves to an array of results from all subscribers, or undefined if no subscribers are present.
Inherited from Channel.getAll
- Defined in common/msg/emitter.ts:57

hasListeners

hasListeners(event: string | number): boolean
Parameters
- event: string | number
Returns boolean
Inherited from Channel.hasListeners
- Defined in common/msg/emitter.ts:175

off

off(event: U, listener: DefaultListener[U]): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from Channel.off
- Defined in common/msg/emitter.ts:161

on

on(
 event: U,
 fn: DefaultListener[U],
 opt?: EmitterSubscriberOptions,
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- fn: DefaultListener[U]
- opt: EmitterSubscriberOptions = {}
Returns DisposerFunction
Inherited from Channel.on
- Defined in common/msg/emitter.ts:114

onAny

onAny(fn: EmitterHandler): void
Parameters
- fn: EmitterHandler
Returns void
Inherited from Channel.onAny
- Defined in common/msg/emitter.ts:110

onCall

onCall(handlers: Partial<LocalListener>): void
Parameters
- handlers: Partial<LocalListener>
Returns void
Inherited from Channel.onCall
- Defined in common/msg/emitter.ts:142

once

once(
event: U,
listener: DefaultListener[U],
): DisposerFunction
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns DisposerFunction
Inherited from Channel.once
- Defined in common/msg/emitter.ts:147

postMessage

postMessage(data: string | Uint8Array<ArrayBufferLike>): void
Parameters
- data: string | Uint8Array<ArrayBufferLike>
Returns void
Overrides Channel.postMessage
- Defined in common/msg/channel-resilient.ts:64

removeAllListeners

removeAllListeners(): this
Returns this
Inherited from Channel.removeAllListeners
- Defined in common/msg/emitter.ts:170

removeEventListener

removeEventListener(
event: U,
listener: DefaultListener[U],
): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from Channel.removeEventListener
- Defined in common/msg/emitter.ts:210

setChannel

setChannel(channel?: Channel<any, Record<string, any>>): void
Set a new channel and flush buffer
Parameters
- Optionalchannel: Channel<any, Record<string, any>>
Returns void
- Defined in common/msg/channel-resilient.ts:46

waitOn

waitOn[0]>(
event: U,
timeoutMS?: number,
): Promise<R>
Type Parameters
- U extends string | number
- R = Parameters<DefaultListener[U]>[0]
Parameters
- event: U
- timeoutMS: number = 1000
Returns Promise<R>
Inherited from Channel.waitOn
- Defined in common/msg/emitter.ts:181

Class ResillientChannel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ResillientChannel

Properties

_logEmitter

call

context

dispose

Type Declaration

Parameters

Returns void | Promise<any>

add: (obj?: DisposableEntry) => DisposerFunction | undefined

dispose: (strictSync?: boolean) => void | Promise<any>

disposeSync: () => void

exec: (strictSync?: boolean) => void | Promise<any>

Deprecated

remove: (disposable: DisposableEntry) => void | Promise<void>

sync: () => void

track: (obj?: DisposableEntry) => DisposerFunction | undefined

Deprecated

untrack: (disposable: DisposableEntry) => void | Promise<void>

Deprecated

get disposed(): number

[asyncDispose]: function

Returns Promise<any>

[dispose]: function

Returns void | Promise<any>

getSize: function

Returns number

isDisposed: function

Returns boolean

interval: (fn: TimerExecFunction, interval?: number) => DisposerFunction

intervalPause: (fn: TimerExecFunction, interval?: number) => DisposerFunction

on: ( emitter: any, eventName: string, fn: (ev?: any) => void, ...args: any[],) => DisposerFunction

once: ( emitter: any, eventName: string, fn: (ev?: any) => void, ...args: any[],) => DisposerFunction

timeout: (fn: TimerExecFunction, timeout?: number) => DisposerFunction

id

Accessors

isConnected

Returns boolean

Methods

addEventListener

Type Parameters

Parameters

Returns DisposerFunction

close

Returns void

Deprecated

deleteChannel

Returns void

Deprecated

emit

Type Parameters

Parameters

Returns Promise<boolean>

emptyBuffer

Returns void

flushBuffer

Returns void

get

Type Parameters

Parameters

Returns Promise< | ReturnType< { close: () => void; connect: () => void; disconnect: () => void; message: (event: ChannelMessageEvent<any>) => void; messageerror: (event: ChannelMessageEvent<any>) => void; }[U], > | undefined,>

getAll

Type Parameters

Parameters

Returns Promise< | ReturnType< { close: () => void; connect: () => void; disconnect: () => void; message: (event: ChannelMessageEvent<any>) => void; messageerror: (event: ChannelMessageEvent<any>) => void; }[U], >[] | undefined,>

hasListeners

Parameters

Returns boolean

off

Type Parameters

Parameters

on: (
emitter: any,
eventName: string,
fn: (ev?: any) => void,
...args: any[],
) => DisposerFunction

once: (
emitter: any,
eventName: string,
fn: (ev?: any) => void,
...args: any[],
) => DisposerFunction

Returns Promise<
| ReturnType<
{
close: () => void;
connect: () => void;
disconnect: () => void;
message: (event: ChannelMessageEvent<any>) => void;
messageerror: (event: ChannelMessageEvent<any>) => void;
}[U],
>
| undefined,
>

Returns Promise<
| ReturnType<
{
close: () => void;
connect: () => void;
disconnect: () => void;
message: (event: ChannelMessageEvent<any>) => void;
messageerror: (event: ChannelMessageEvent<any>) => void;
}[U],
>[]
| undefined,
>