import type { HttpMethods, ProxySettings } from "@azure/core-rest-pipeline";
|
import type { AbortSignalLike } from "@azure/abort-controller";
|
import type { HttpHeaders as HttpHeadersV2, PipelineRequest } from "@azure/core-rest-pipeline";
|
export declare function toPipelineRequest(webResource: WebResourceLike, options?: {
|
originalRequest?: PipelineRequest;
|
}): PipelineRequest;
|
export declare function toWebResourceLike(request: PipelineRequest, options?: {
|
createProxy?: boolean;
|
originalRequest?: PipelineRequest;
|
}): WebResourceLike;
|
/**
|
* Converts HttpHeaders from core-rest-pipeline to look like
|
* HttpHeaders from core-http.
|
* @param headers - HttpHeaders from core-rest-pipeline
|
* @returns HttpHeaders as they looked in core-http
|
*/
|
export declare function toHttpHeadersLike(headers: HttpHeadersV2): HttpHeadersLike;
|
/**
|
* An individual header within a HttpHeaders collection.
|
*/
|
export interface HttpHeader {
|
/**
|
* The name of the header.
|
*/
|
name: string;
|
/**
|
* The value of the header.
|
*/
|
value: string;
|
}
|
/**
|
* A HttpHeaders collection represented as a simple JSON object.
|
*/
|
export type RawHttpHeaders = {
|
[headerName: string]: string;
|
};
|
/**
|
* A collection of HTTP header key/value pairs.
|
*/
|
export interface HttpHeadersLike {
|
/**
|
* Set a header in this collection with the provided name and value. The name is
|
* case-insensitive.
|
* @param headerName - The name of the header to set. This value is case-insensitive.
|
* @param headerValue - The value of the header to set.
|
*/
|
set(headerName: string, headerValue: string | number): void;
|
/**
|
* Get the header value for the provided header name, or undefined if no header exists in this
|
* collection with the provided name.
|
* @param headerName - The name of the header.
|
*/
|
get(headerName: string): string | undefined;
|
/**
|
* Get whether or not this header collection contains a header entry for the provided header name.
|
*/
|
contains(headerName: string): boolean;
|
/**
|
* Remove the header with the provided headerName. Return whether or not the header existed and
|
* was removed.
|
* @param headerName - The name of the header to remove.
|
*/
|
remove(headerName: string): boolean;
|
/**
|
* Get the headers that are contained this collection as an object.
|
*/
|
rawHeaders(): RawHttpHeaders;
|
/**
|
* Get the headers that are contained in this collection as an array.
|
*/
|
headersArray(): HttpHeader[];
|
/**
|
* Get the header names that are contained in this collection.
|
*/
|
headerNames(): string[];
|
/**
|
* Get the header values that are contained in this collection.
|
*/
|
headerValues(): string[];
|
/**
|
* Create a deep clone/copy of this HttpHeaders collection.
|
*/
|
clone(): HttpHeadersLike;
|
/**
|
* Get the JSON object representation of this HTTP header collection.
|
* The result is the same as `rawHeaders()`.
|
*/
|
toJson(options?: {
|
preserveCase?: boolean;
|
}): RawHttpHeaders;
|
}
|
/**
|
* A collection of HTTP header key/value pairs.
|
*/
|
export declare class HttpHeaders implements HttpHeadersLike {
|
private readonly _headersMap;
|
constructor(rawHeaders?: RawHttpHeaders);
|
/**
|
* Set a header in this collection with the provided name and value. The name is
|
* case-insensitive.
|
* @param headerName - The name of the header to set. This value is case-insensitive.
|
* @param headerValue - The value of the header to set.
|
*/
|
set(headerName: string, headerValue: string | number): void;
|
/**
|
* Get the header value for the provided header name, or undefined if no header exists in this
|
* collection with the provided name.
|
* @param headerName - The name of the header.
|
*/
|
get(headerName: string): string | undefined;
|
/**
|
* Get whether or not this header collection contains a header entry for the provided header name.
|
*/
|
contains(headerName: string): boolean;
|
/**
|
* Remove the header with the provided headerName. Return whether or not the header existed and
|
* was removed.
|
* @param headerName - The name of the header to remove.
|
*/
|
remove(headerName: string): boolean;
|
/**
|
* Get the headers that are contained this collection as an object.
|
*/
|
rawHeaders(): RawHttpHeaders;
|
/**
|
* Get the headers that are contained in this collection as an array.
|
*/
|
headersArray(): HttpHeader[];
|
/**
|
* Get the header names that are contained in this collection.
|
*/
|
headerNames(): string[];
|
/**
|
* Get the header values that are contained in this collection.
|
*/
|
headerValues(): string[];
|
/**
|
* Get the JSON object representation of this HTTP header collection.
|
*/
|
toJson(options?: {
|
preserveCase?: boolean;
|
}): RawHttpHeaders;
|
/**
|
* Get the string representation of this HTTP header collection.
|
*/
|
toString(): string;
|
/**
|
* Create a deep clone/copy of this HttpHeaders collection.
|
*/
|
clone(): HttpHeaders;
|
}
|
/**
|
* An interface compatible with NodeJS's `http.Agent`.
|
* We want to avoid publicly re-exporting the actual interface,
|
* since it might vary across runtime versions.
|
*/
|
export interface Agent {
|
/**
|
* Destroy any sockets that are currently in use by the agent.
|
*/
|
destroy(): void;
|
/**
|
* For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.
|
*/
|
maxFreeSockets: number;
|
/**
|
* Determines how many concurrent sockets the agent can have open per origin.
|
*/
|
maxSockets: number;
|
/**
|
* An object which contains queues of requests that have not yet been assigned to sockets.
|
*/
|
requests: unknown;
|
/**
|
* An object which contains arrays of sockets currently in use by the agent.
|
*/
|
sockets: unknown;
|
}
|
/**
|
* A description of a HTTP request to be made to a remote server.
|
*/
|
export interface WebResourceLike {
|
/**
|
* The URL being accessed by the request.
|
*/
|
url: string;
|
/**
|
* The HTTP method to use when making the request.
|
*/
|
method: HttpMethods;
|
/**
|
* The HTTP body contents of the request.
|
*/
|
body?: any;
|
/**
|
* The HTTP headers to use when making the request.
|
*/
|
headers: HttpHeadersLike;
|
/**
|
* Whether or not the body of the HttpOperationResponse should be treated as a stream.
|
* @deprecated Use streamResponseStatusCodes property instead.
|
*/
|
streamResponseBody?: boolean;
|
/**
|
* A list of response status codes whose corresponding HttpOperationResponse body should be treated as a stream.
|
*/
|
streamResponseStatusCodes?: Set<number>;
|
/**
|
* Form data, used to build the request body.
|
*/
|
formData?: any;
|
/**
|
* A query string represented as an object.
|
*/
|
query?: {
|
[key: string]: any;
|
};
|
/**
|
* If credentials (cookies) should be sent along during an XHR.
|
*/
|
withCredentials: boolean;
|
/**
|
* The number of milliseconds a request can take before automatically being terminated.
|
* If the request is terminated, an `AbortError` is thrown.
|
*/
|
timeout: number;
|
/**
|
* Proxy configuration.
|
*/
|
proxySettings?: ProxySettings;
|
/**
|
* If the connection should be reused.
|
*/
|
keepAlive?: boolean;
|
/**
|
* Whether or not to decompress response according to Accept-Encoding header (node-fetch only)
|
*/
|
decompressResponse?: boolean;
|
/**
|
* A unique identifier for the request. Used for logging and tracing.
|
*/
|
requestId: string;
|
/**
|
* Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.
|
*/
|
abortSignal?: AbortSignalLike;
|
/**
|
* Callback which fires upon upload progress.
|
*/
|
onUploadProgress?: (progress: TransferProgressEvent) => void;
|
/** Callback which fires upon download progress. */
|
onDownloadProgress?: (progress: TransferProgressEvent) => void;
|
/**
|
* NODEJS ONLY
|
*
|
* A Node-only option to provide a custom `http.Agent`/`https.Agent`.
|
* NOTE: usually this should be one instance shared by multiple requests so that the underlying
|
* connection to the service can be reused.
|
* Does nothing when running in the browser.
|
*/
|
agent?: Agent;
|
/**
|
* Additional options to set on the request. This provides a way to override
|
* existing ones or provide request properties that are not declared.
|
*
|
* For possible valid properties, see
|
* - NodeJS https.request options: https://nodejs.org/api/http.html#httprequestoptions-callback
|
* - Browser RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
|
*
|
* WARNING: Options specified here will override any properties of same names when request is sent by {@link HttpClient}.
|
*/
|
requestOverrides?: Record<string, unknown>;
|
/**
|
* Clone this request object.
|
*/
|
clone(): WebResourceLike;
|
/**
|
* Validates that the required properties such as method, url, headers["Content-Type"],
|
* headers["accept-language"] are defined. It will throw an error if one of the above
|
* mentioned properties are not defined.
|
* Note: this a no-op for compat purposes.
|
*/
|
validateRequestProperties(): void;
|
/**
|
* This is a no-op for compat purposes and will throw if called.
|
*/
|
prepare(options: unknown): WebResourceLike;
|
}
|
/**
|
* Fired in response to upload or download progress.
|
*/
|
export type TransferProgressEvent = {
|
/**
|
* The number of bytes loaded so far.
|
*/
|
loadedBytes: number;
|
};
|
//# sourceMappingURL=util.d.ts.map
|
