@libp2p/http
    Preparing search index...

    Interface PingHTTPOptions

    interface PingHTTPOptions {
        authenticateServer?: boolean;
        body?: null | BodyInit;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        headers?: HeadersInit;
        integrity?: string;
        keepalive?: boolean;
        maxHeaderSize?: number;
        method?: string;
        middleware?: ((components: any) => Middleware)[];
        mode?: RequestMode;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        signal?: AbortSignal;
        window?: null;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authenticateServer? body? cache? credentials? headers? integrity? keepalive? maxHeaderSize? method? middleware? mode? priority? redirect? referrer? referrerPolicy? signal? window?

    Properties

    authenticateServer?: boolean

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

    false

    Optionalbody

    body?: null | BodyInit

    A BodyInit object or null to set request's body.

    cache?: RequestCache

    A string indicating how the request will interact with the browser's cache to set request's cache.

    credentials?: RequestCredentials

    A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

    headers?: HeadersInit

    A Headers object, an object literal, or an array of two-item arrays to set request's headers.

    integrity?: string

    A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

    keepalive?: boolean

    A boolean to set request's keepalive.

    maxHeaderSize?: number

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

    81_920
    method?: string

    A string to set request's method.

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

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

    mode?: RequestMode

    A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

    priority?: RequestPriority
    redirect?: RequestRedirect

    A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

    referrer?: string

    A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

    referrerPolicy?: ReferrerPolicy

    A referrer policy to set request's referrerPolicy.

    signal?: AbortSignal

    An AbortSignal to set request's signal.

    window?: null

    Can only be null. Used to disassociate request from any Window.

    Settings

    Member Visibility

    On This Page

    Properties