libp2p
    Preparing search index...

    Interface UpgraderOptions<ConnectionUpgradeEvents>

    Options accepted by the upgrader during connection establishment

    interface UpgraderOptions<
        ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent,
    > {
        initiator?: boolean;
        limits?: ConnectionLimits;
        muxerFactory?: StreamMuxerFactory;
        onProgress?: (evt: ConnectionUpgradeEvents) => void;
        signal: AbortSignal;
        skipEncryption?: boolean;
        skipProtection?: boolean;
    }

    Type Parameters

    Hierarchy

    Index

    Properties

    initiator? limits? muxerFactory? onProgress? signal skipEncryption? skipProtection?

    Properties

    initiator?: boolean

    Multi-stream select is a initiator/responder protocol. By default a connection returned from upgrader.upgradeOutbound will be the initiator and one returned from upgrader.upgradeInbound will be the responder.

    Pass a value here to override the default.

    limits?: ConnectionLimits

    If the connection is to have limits applied to it, pass them here

    muxerFactory?: StreamMuxerFactory

    By default a stream muxer protocol will be negotiated via multi-stream select after an encryption protocol has been agreed on.

    If a transport provides it's own stream muxing facility pass a muxer factory instance here to skip muxer negotiation.

    onProgress?: (evt: ConnectionUpgradeEvents) => void
    signal: AbortSignal
    skipEncryption?: boolean

    If true the invoking transport is expected to implement it's own encryption and an encryption protocol will not attempted to be negotiated via multi-stream select

    false
    skipProtection?: boolean

    If true no connection protection will be performed on the connection.

    Settings

    Member Visibility

    On This Page

    Properties