Skip to content

API reference > @kontsedal/olas-cross-tab > defaultChannelFactory

defaultChannelFactory() function ​

Default factory: wraps the platform BroadcastChannel in a browser tab or a web worker. Returns undefined anywhere else, such as on a Node, Bun or Deno server, and where BroadcastChannel is not defined. AchannelFactory passed to crossTabPlugin opens a channel wherever it returns one.

Signature:

typescript
export declare function defaultChannelFactory(name: string): ChannelLike | undefined;

Parameters ​

Parameter

Type

Description

name

string

Returns:

ChannelLike | undefined

Released under the MIT License.