RemoteChannel.WriteConfig | /channel/custom/index.ts | rimbu@1.2.0

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.

interface RemoteChannel.WriteConfig

import { type RemoteChannel } from "https://deno.land/x/rimbu@1.2.0/channel/custom/index.ts";
const { WriteConfig } = RemoteChannel;

Interface defining the write configuration for a RemoteChannel.

Properties

channelId: string

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

optional

capacity: number

The maximum amount of messages the Channel can buffer. If 0, the channel is unbuffered and the communication is synchronous.

optional

validator: (value: any) => boolean

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

optional

maxHandshakeAttempts: number

The amount of handshake attempts to make before failing.

optional

handshakeAttemptTimeoutMs: number

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