UNPKG

2.62 kBTypeScriptView Raw
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 * @usageNotes
16 * ### Example
17 *
18 * ```
19 * import {Headers} from '@angular/http';
20 *
21 * var firstHeaders = new Headers();
22 * firstHeaders.append('Content-Type', 'image/jpeg');
23 * console.log(firstHeaders.get('Content-Type')) //'image/jpeg'
24 *
25 * // Create headers from Plain Old JavaScript Object
26 * var secondHeaders = new Headers({
27 * 'X-My-Custom-Header': 'Angular'
28 * });
29 * console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular'
30 *
31 * var thirdHeaders = new Headers(secondHeaders);
32 * console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular'
33 * ```
34 *
35 * @deprecated see https://angular.io/guide/http
36 * @publicApi
37 */
38export declare class Headers {
39 constructor(headers?: Headers | {
40 [name: string]: any;
41 } | null);
42 /**
43 * Returns a new Headers instance from the given DOMString of Response Headers
44 */
45 static fromResponseHeaderString(headersString: string): Headers;
46 /**
47 * Appends a header to existing list of header values for a given header name.
48 */
49 append(name: string, value: string): void;
50 /**
51 * Deletes all header values for the given name.
52 */
53 delete(name: string): void;
54 forEach(fn: (values: string[], name: string | undefined, headers: Map<string, string[]>) => void): void;
55 /**
56 * Returns first header that matches given name.
57 */
58 get(name: string): string | null;
59 /**
60 * Checks for existence of header by given name.
61 */
62 has(name: string): boolean;
63 /**
64 * Returns the names of the headers
65 */
66 keys(): string[];
67 /**
68 * Sets or overrides header value for given name.
69 */
70 set(name: string, value: string | string[]): void;
71 /**
72 * Returns values of all headers.
73 */
74 values(): string[][];
75 /**
76 * Returns string of all headers.
77 */
78 toJSON(): {
79 [name: string]: any;
80 };
81 /**
82 * Returns list of header values for a given name.
83 */
84 getAll(name: string): string[] | null;
85 /**
86 * This method is not implemented.
87 */
88 entries(): void;
89 private mayBeSetNormalizedName;
90}