peerix - v0.1.0
    Preparing search index...

    Interface PeerJoinOptions

    Options for joining a room by calling Peer.join.

    interface PeerJoinOptions {
        metadata?: any;
        room?: string;
        verify?: (
            options: { id: string; metadata?: any },
        ) => boolean | Promise<boolean>;
    }
    Index

    Properties

    metadata? room? verify?

    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.

    verify?: (options: { id: string; metadata?: any }) => boolean | Promise<boolean>

    Optional callback to accept or reject incoming peer connections.

    Type Declaration

      • (options: { id: string; metadata?: any }): boolean | Promise<boolean>

      • Parameters

        • options: { id: string; metadata?: any }

          Options describing the incoming peer connection.

          • id: string

            Remote peer identifier.

          • Optionalmetadata?: any

            Remote peer metadata.

        Returns boolean | Promise<boolean>

        A boolean or promise indicating whether the incoming connection should be accepted.

    Settings

    Member Visibility

    On This Page

    Properties