Beignet API reference
    Preparing search index...

    Interface TrustedRequestInfo

    Request metadata after applying an explicit trusted-proxy policy.

    interface TrustedRequestInfo {
        clientIp?: string;
        clientIpTrusted: boolean;
        host: string;
        origin: string;
        protocol: "http" | "https";
        trustedProxy: boolean;
        url: Readonly<URL>;
    }
    Index
    clientIp? clientIpTrusted host origin protocol trustedProxy url
    clientIp?: string

    Resolved client IP when a trusted client-IP source is configured.

    clientIpTrusted: boolean

    Whether the server policy configured a trusted client-IP source. This can be true while clientIp is absent when the expected header is missing.

    host: string

    External request host, including port when present.

    origin: string

    External request origin.

    protocol: "http" | "https"

    External request protocol without a trailing colon.

    trustedProxy: boolean

    Whether forwarding headers were eligible to affect this result.

    url: Readonly<URL>

    URL as seen by the app or reconstructed from trusted proxy headers.

    Settings
    Member Visibility

    On This Page
    Properties