Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/rimbu/channel/custom/remote-channel-client/remote-channel-client.ts>RemoteChannelClient

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.
rimbu-org/rimbu
Go to Latest
namespace RemoteChannelClient
import { RemoteChannelClient } from "https://deno.land/x/rimbu@1.0.2/channel/custom/remote-channel-client/remote-channel-client.ts";

Interfaces

Interface defining the confirgartion options for a RemoteChannelClient

Defines the static RemoteChannelClient API.

Interface defining the configuration options for creating a remote Channel.Cross channel

Interface defining the configuration options for creating a remote Channel.Read channel

Interface defining the configuration options for creating a remote Channel.Write channel

interface RemoteChannelClient
import { type RemoteChannelClient } from "https://deno.land/x/rimbu@1.0.2/channel/custom/remote-channel-client/remote-channel-client.ts";

A RemoteChannelClient allows creating channels to communicate with a RemoteChannelServer. The server should be configured to listen to channels with the channel ids provided to the channel creation functions in the client.

Methods

createRead<T>(config: RemoteChannelClient.ReadChannelConfig): Promise<Channel.Read<T>>

Resolves, if succesful, to a new remote read channel.

createWrite<T>(config: RemoteChannelClient.WriteChannelConfig): Promise<Channel.Write<T>>

Resolves, if succesful, to a new remote write channel.

createCross<TSend = void, TReceive = TSend>(config: RemoteChannelClient.CrossChannelConfig): Promise<CrossChannel<TSend, TReceive>>

Resolves, if succesful, to a new remote cross channel.

variable RemoteChannelClient
import { RemoteChannelClient } from "https://deno.land/x/rimbu@1.0.2/channel/custom/remote-channel-client/remote-channel-client.ts";