@libp2p/http
    Preparing search index...

    Interface PingWebSocketOptions

    Options used to control Fetch request and the initial WebSocket upgrade request

    interface PingWebSocketOptions {
        authenticateServer?: boolean;
        headers?: HeadersInit;
        maxHeaderSize?: number;
        maxMessageSize?: number;
        middleware?: ((components: any) => Middleware)[];
        protocols?: string[];
        signal?: AbortSignal;
        webSocket: true;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authenticateServer? headers? maxHeaderSize? maxMessageSize? middleware? protocols? signal? webSocket

    Properties

    authenticateServer?: boolean

    If true, verify the server's peer id using PeerId Authentication

    false
    headers?: HeadersInit

    Headers to send with the initial upgrade request

    maxHeaderSize?: number

    The maximum number of bytes that will be parsed as response headers

    81_920
    maxMessageSize?: number

    The maximum message size to be sent or received over the socket in bytes

    10_485_760
    middleware?: ((components: any) => Middleware)[]

    A list of request processors that can augment requests - if specified will override any processors passed to the http service

    protocols?: string[]

    Protocols to send with the upgrade request

    signal?: AbortSignal
    webSocket: true

    Make a request over a WebSocket instead of HTTP

    Settings

    Member Visibility

    On This Page

    Properties