github.com/jfrog/frogbot@v1.1.1-0.20231221090046-821a26f50338/action/node_modules/@actions/http-client/lib/interfaces.d.ts (about)

     1  /// <reference types="node" />
     2  import * as http from 'http';
     3  import * as https from 'https';
     4  import { HttpClientResponse } from './index';
     5  export interface HttpClient {
     6      options(requestUrl: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
     7      get(requestUrl: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
     8      del(requestUrl: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
     9      post(requestUrl: string, data: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
    10      patch(requestUrl: string, data: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
    11      put(requestUrl: string, data: string, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
    12      sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
    13      request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: http.OutgoingHttpHeaders): Promise<HttpClientResponse>;
    14      requestRaw(info: RequestInfo, data: string | NodeJS.ReadableStream): Promise<HttpClientResponse>;
    15      requestRawWithCallback(info: RequestInfo, data: string | NodeJS.ReadableStream, onResult: (err?: Error, res?: HttpClientResponse) => void): void;
    16  }
    17  export interface RequestHandler {
    18      prepareRequest(options: http.RequestOptions): void;
    19      canHandleAuthentication(response: HttpClientResponse): boolean;
    20      handleAuthentication(httpClient: HttpClient, requestInfo: RequestInfo, data: string | NodeJS.ReadableStream | null): Promise<HttpClientResponse>;
    21  }
    22  export interface RequestInfo {
    23      options: http.RequestOptions;
    24      parsedUrl: URL;
    25      httpModule: typeof http | typeof https;
    26  }
    27  export interface RequestOptions {
    28      headers?: http.OutgoingHttpHeaders;
    29      socketTimeout?: number;
    30      ignoreSslError?: boolean;
    31      allowRedirects?: boolean;
    32      allowRedirectDowngrade?: boolean;
    33      maxRedirects?: number;
    34      maxSockets?: number;
    35      keepAlive?: boolean;
    36      deserializeDates?: boolean;
    37      allowRetries?: boolean;
    38      maxRetries?: number;
    39  }
    40  export interface TypedResponse<T> {
    41      statusCode: number;
    42      result: T | null;
    43      headers: http.IncomingHttpHeaders;
    44  }