File Explorer

1/*2 *3 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.4 * SPDX-License-Identifier: Apache-2.0.5 */6 7/**8 *9 * A module containing support for creating http connections and making requests on them.10 *11 * @packageDocumentation12 * @module http13 */14 15/**16 * HTTP protocol version17 *18 * @category HTTP19 */20export enum HttpVersion {21    Unknown = 0,22    /** HTTP/1.0 */23    Http1_0 = 1,24    /** HTTP/1.1 */25    Http1_1 = 2,26    /** HTTP/2 */27    Http2 = 3,28}29 30/**31 * Headers are exposed as 2 element arrays: [name, value]32 *33 * @category HTTP34 */35export type HttpHeader = [string, string];36 37/**38 * Common interface for a set of HTTP headers.39 *40 * @category HTTP41 */42export interface HttpHeaders {43    readonly length: number;44 45    /**46     * Add a name/value pair47     * @param name - The header name48     * @param value - The header value49    */50    add(name: string, value: string): void;51 52    /**53     * Set a name/value pair, replacing any existing values for the name54     * @param name - The header name55     * @param value - The header value56    */57    set(name: string, value: string): void;58 59    /**60     * Get the list of values for the given name61     * @param name - The header name to look for62     * @return List of values, or empty list if none exist63     */64    get_values(name: string): string[];65 66    /**67     * Gets the first value for the given name, ignoring any additional values68     * @param name - The header name to look for69     * @param default_value - Value returned if no values are found for the given name70     * @return The first header value, or default if no values exist71     */72    get(name: string, default_value?: string): string;73 74    /**75     * Removes all values for the given name76     * @param name - The header to remove all values for77     */78    remove(name: string): void;79 80    /**81     * Removes a specific name/value pair82     * @param name - The header name to remove83     * @param value - The header value to remove84     */85    remove_value(name: string, value: string): void;86 87    /** Clears the entire header set */88    clear(): void;89 90    /**91     * Iterator. Allows for:92     * let headers = new HttpHeaders();93     * ...94     * for (const header of headers) { }95    */96    [Symbol.iterator](): Iterator<HttpHeader>;97 98    /** @hidden */99    _flatten(): HttpHeader[];100}101 102/**103 * Proxy authentication types104 *105 * @category HTTP106 */107export enum HttpProxyAuthenticationType {108 109    /**110     * No to-proxy authentication logic111     */112    None = 0,113 114    /**115     * Use basic authentication (user/pass).  Supply these values in {@link HttpProxyOptions}116     */117    Basic = 1,118};119 120/**121 * Options used when connecting to an HTTP endpoint via a proxy122 *123 * @category HTTP124 */125export class CommonHttpProxyOptions {126 127    /**128     *129     * @param host_name endpoint of the proxy to use130     * @param port port of proxy to use131     * @param auth_method type of authentication to use with the proxy132     * @param auth_username (basic authentication only) proxy username133     * @param auth_password (basic authentication only) password associated with the username134     */135    constructor(136        public host_name: string,137        public port: number,138        public auth_method = HttpProxyAuthenticationType.None,139        public auth_username?: string,140        public auth_password?: string141    ) {142    }143}144 145/**146 * Listener signature for event emitted from an {@link HttpClientConnection} when the connection reaches the147 * connected state148 *149 * @category HTTP150 */151export type HttpClientConnectionConnected = () => void;152 153/**154 * Listener signature for event emitted from an {@link HttpClientConnection} when an error occurs155 *156 * @param error - A CrtError containing the error that occurred157 *158 * @category HTTP159 */160export type HttpClientConnectionError = (error: Error) => void;161 162/**163 * Listener signature for event emitted from an {@link HttpClientConnection} when the connection has been closed164 *165 * @category HTTP166 */167export type HttpClientConnectionClosed = () => void;168 169/**170 * Listener signature for event emitted from an {@link HttpClientStream} when http response data is available171 *172 * @param body_data - The chunk of body data173 *174 * @category HTTP175 */176export type HttpStreamData = (body_data: ArrayBuffer) => void;177 178 179/**180 * Listener signature for event emitted from an {@link HttpClientStream} when an http stream error occurs181 *182 * @param error - A CrtError containing the error that occurred183 *184 * @category HTTP185 */186export type HttpStreamError = (error: Error) => void;187 188/**189 * Listener signature for event emitted from an {@link HttpClientStream} when the http stream has completed.190 *191 * @category HTTP192 */193export type HttpStreamComplete = () => void;194 195