API Reference
    Preparing search index...

    Interface JoinOptions

    Options for joining a room.

    interface JoinOptions {
        metadata?: any;
        room?: string;
    }
    Index

    Properties

    Properties

    metadata?: any

    Optional metadata to advertise to the remote peer.

    room?: string

    Room name to join. If omitted, the peer will join a room with the default name.