Project

General

Profile

1
/**
2
 * @license
3
 * Copyright Google Inc. All Rights Reserved.
4
 *
5
 * Use of this source code is governed by an MIT-style license that can be
6
 * found in the LICENSE file at https://angular.io/license
7
 */
8
/**
9
 * Polyfill for [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers/Headers), as
10
 * specified in the [Fetch Spec](https://fetch.spec.whatwg.org/#headers-class).
11
 *
12
 * The only known difference between this `Headers` implementation and the spec is the
13
 * lack of an `entries` method.
14
 *
15
 * ### Example
16
 *
17
 * ```
18
 * import {Headers} from '@angular/http';
19
 *
20
 * var firstHeaders = new Headers();
21
 * firstHeaders.append('Content-Type', 'image/jpeg');
22
 * console.log(firstHeaders.get('Content-Type')) //'image/jpeg'
23
 *
24
 * // Create headers from Plain Old JavaScript Object
25
 * var secondHeaders = new Headers({
26
 *   'X-My-Custom-Header': 'Angular'
27
 * });
28
 * console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular'
29
 *
30
 * var thirdHeaders = new Headers(secondHeaders);
31
 * console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular'
32
 * ```
33
 *
34
 * @experimental
35
 */
36
export declare class Headers {
37
    constructor(headers?: Headers | {
38
        [name: string]: any;
39
    } | null);
40
    /**
41
     * Returns a new Headers instance from the given DOMString of Response Headers
42
     */
43
    static fromResponseHeaderString(headersString: string): Headers;
44
    /**
45
     * Appends a header to existing list of header values for a given header name.
46
     */
47
    append(name: string, value: string): void;
48
    /**
49
     * Deletes all header values for the given name.
50
     */
51
    delete(name: string): void;
52
    forEach(fn: (values: string[], name: string | undefined, headers: Map<string, string[]>) => void): void;
53
    /**
54
     * Returns first header that matches given name.
55
     */
56
    get(name: string): string | null;
57
    /**
58
     * Checks for existence of header by given name.
59
     */
60
    has(name: string): boolean;
61
    /**
62
     * Returns the names of the headers
63
     */
64
    keys(): string[];
65
    /**
66
     * Sets or overrides header value for given name.
67
     */
68
    set(name: string, value: string | string[]): void;
69
    /**
70
     * Returns values of all headers.
71
     */
72
    values(): string[][];
73
    /**
74
     * Returns string of all headers.
75
     */
76
    toJSON(): {
77
        [name: string]: any;
78
    };
79
    /**
80
     * Returns list of header values for a given name.
81
     */
82
    getAll(name: string): string[] | null;
83
    /**
84
     * This method is not implemented.
85
     */
86
    entries(): void;
87
    private mayBeSetNormalizedName(name);
88
}
(5-5/14)