Type Alias JoinRoomConfig<PeerMetadata>

JoinRoomConfig: {
    config?: ConnectionConfig;
    peerMetadata?: PeerMetadata;
    peerToken: string;
} & (
    { fishjamId: string; url?: never }
    | { fishjamId?: never; url: string }
)

Type Parameters

PeerMetadata extends GenericMetadata = GenericMetadata

Type declaration

Optionalconfig?: ConnectionConfig
Additional connection configuration
OptionalpeerMetadata?: PeerMetadata
String indexed record with metadata, that will be available to all other peers
peerToken: string
Token received from server (or Room Manager)

{ fishjamId: string; url?: never }
- fishjamId: string
  Fishjam ID, which is used to connect to the room. Only use in sandbox. If provided, url must not be set.
- Optionalurl?: never
{ fishjamId?: never; url: string }
- OptionalfishjamId?: never
- url: string
  Fishjam URL, used to connect to the room. If provided, fishjamId must not be set.