Interface ChannelConnectOptions

Options provided on a client connection to a channel.

interface ChannelConnectOptions {
    payload?: any;
    protocols?: ("classic" | "rtc")[];
    wait?: boolean;
}

Properties

payload?: any

Payload to pass to ChannelProvider onConnection action.

protocols?: ("classic" | "rtc")[]

EXPERIMENTAL: Messaging protocols supported by the channel provider.

wait?: boolean

If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.

true