Fake Mirrors
    Preparing search index...

    Interface HttpClient

    Represents a HTTP client

    interface HttpClient {
        simple(
            proxy: string,
            method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
            url: string,
            requestHeaders: HttpHeaders,
            requestBody: HttpBody,
            connectTimeout: number,
            timeout: number,
            headersSizeLimit: number,
            bodySizeLimit: number,
        ): Promise<HttpClientSimpleResult | HttpClientErrorResult>;
        streamRequest(
            proxy: string,
            method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
            url: string,
            requestHeaders: HttpHeaders,
            requestStream: Readable,
            connectTimeout: number,
            timeout: number,
            headersSizeLimit: number,
            bodySizeLimit: number,
        ): Promise<HttpClientSimpleResult | HttpClientErrorResult>;
        streamResponse(
            proxy: string,
            method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
            url: string,
            requestHeaders: HttpHeaders,
            requestBody: HttpBody,
            connectTimeout: number,
            timeout: number,
            headersSizeLimit: number,
        ): Promise<HttpClientErrorResult | HttpClientStreamResult>;
    }

    Implemented by

    Methods

    • Simple HTTP request and response

      Parameters

      • proxy: string
      • method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
      • url: string
      • requestHeaders: HttpHeaders
      • requestBody: HttpBody
      • connectTimeout: number
      • timeout: number
      • headersSizeLimit: number
      • bodySizeLimit: number

      Returns Promise<HttpClientSimpleResult | HttpClientErrorResult>

    • Streaming HTTP request and simple response

      Parameters

      • proxy: string
      • method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
      • url: string
      • requestHeaders: HttpHeaders
      • requestStream: Readable
      • connectTimeout: number
      • timeout: number
      • headersSizeLimit: number
      • bodySizeLimit: number

      Returns Promise<HttpClientSimpleResult | HttpClientErrorResult>

    • Simple HTTP request and streaming response

      Parameters

      • proxy: string
      • method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
      • url: string
      • requestHeaders: HttpHeaders
      • requestBody: HttpBody
      • connectTimeout: number
      • timeout: number
      • headersSizeLimit: number

      Returns Promise<HttpClientErrorResult | HttpClientStreamResult>

    Methods