File Explorer

1/**2 *3 * A module containing support for creating http connections and making requests on them.4 *5 * @packageDocumentation6 * @module http7 */8/**9 * HTTP protocol version10 *11 * @category HTTP12 */13export declare enum HttpVersion {14    Unknown = 0,15    /** HTTP/1.0 */16    Http1_0 = 1,17    /** HTTP/1.1 */18    Http1_1 = 2,19    /** HTTP/2 */20    Http2 = 321}22/**23 * Headers are exposed as 2 element arrays: [name, value]24 *25 * @category HTTP26 */27export type HttpHeader = [string, string];28/**29 * Common interface for a set of HTTP headers.30 *31 * @category HTTP32 */33export interface HttpHeaders {34    readonly length: number;35    /**36     * Add a name/value pair37     * @param name - The header name38     * @param value - The header value39    */40    add(name: string, value: string): void;41    /**42     * Set a name/value pair, replacing any existing values for the name43     * @param name - The header name44     * @param value - The header value45    */46    set(name: string, value: string): void;47    /**48     * Get the list of values for the given name49     * @param name - The header name to look for50     * @return List of values, or empty list if none exist51     */52    get_values(name: string): string[];53    /**54     * Gets the first value for the given name, ignoring any additional values55     * @param name - The header name to look for56     * @param default_value - Value returned if no values are found for the given name57     * @return The first header value, or default if no values exist58     */59    get(name: string, default_value?: string): string;60    /**61     * Removes all values for the given name62     * @param name - The header to remove all values for63     */64    remove(name: string): void;65    /**66     * Removes a specific name/value pair67     * @param name - The header name to remove68     * @param value - The header value to remove69     */70    remove_value(name: string, value: string): void;71    /** Clears the entire header set */72    clear(): void;73    /**74     * Iterator. Allows for:75     * let headers = new HttpHeaders();76     * ...77     * for (const header of headers) { }78    */79    [Symbol.iterator](): Iterator<HttpHeader>;80    /** @hidden */81    _flatten(): HttpHeader[];82}83/**84 * Proxy authentication types85 *86 * @category HTTP87 */88export declare enum HttpProxyAuthenticationType {89    /**90     * No to-proxy authentication logic91     */92    None = 0,93    /**94     * Use basic authentication (user/pass).  Supply these values in {@link HttpProxyOptions}95     */96    Basic = 197}98/**99 * Options used when connecting to an HTTP endpoint via a proxy100 *101 * @category HTTP102 */103export declare class CommonHttpProxyOptions {104    host_name: string;105    port: number;106    auth_method: HttpProxyAuthenticationType;107    auth_username?: string | undefined;108    auth_password?: string | undefined;109    /**110     *111     * @param host_name endpoint of the proxy to use112     * @param port port of proxy to use113     * @param auth_method type of authentication to use with the proxy114     * @param auth_username (basic authentication only) proxy username115     * @param auth_password (basic authentication only) password associated with the username116     */117    constructor(host_name: string, port: number, auth_method?: HttpProxyAuthenticationType, auth_username?: string | undefined, auth_password?: string | undefined);118}119/**120 * Listener signature for event emitted from an {@link HttpClientConnection} when the connection reaches the121 * connected state122 *123 * @category HTTP124 */125export type HttpClientConnectionConnected = () => void;126/**127 * Listener signature for event emitted from an {@link HttpClientConnection} when an error occurs128 *129 * @param error - A CrtError containing the error that occurred130 *131 * @category HTTP132 */133export type HttpClientConnectionError = (error: Error) => void;134/**135 * Listener signature for event emitted from an {@link HttpClientConnection} when the connection has been closed136 *137 * @category HTTP138 */139export type HttpClientConnectionClosed = () => void;140/**141 * Listener signature for event emitted from an {@link HttpClientStream} when http response data is available142 *143 * @param body_data - The chunk of body data144 *145 * @category HTTP146 */147export type HttpStreamData = (body_data: ArrayBuffer) => void;148/**149 * Listener signature for event emitted from an {@link HttpClientStream} when an http stream error occurs150 *151 * @param error - A CrtError containing the error that occurred152 *153 * @category HTTP154 */155export type HttpStreamError = (error: Error) => void;156/**157 * Listener signature for event emitted from an {@link HttpClientStream} when the http stream has completed.158 *159 * @category HTTP160 */161export type HttpStreamComplete = () => void;162