Skip to main content

interface RemoteChannel.ReadConfig

Interface defining the read configuration for a RemoteChannel.

Implemented by: RemoteChannelClient.ReadChannelConfig

Properties​

channelId​

An ID used for the client and server to connect the correct channels to each other.

Definition​

channelId: string;

handshakeAttemptTimeoutMs​

The amount of milliseconds to wait for a reponse to each handshake.

Definition​

handshakeAttemptTimeoutMs?: number;

maxHandshakeAttempts​

The amount of handshake attempts to make before failing.

Definition​

maxHandshakeAttempts?: number;

validator​

A function taking a message and returning true if the message is of a valid type, false otherwise

Definition​

validator?: (value: any) => boolean;