/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import {ListWrapper, MapWrapper, StringMapWrapper, isListLikeIterable, iterateListLike} from '../src/facade/collection'; import {isBlank} from '../src/facade/lang'; /** * Polyfill for [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers/Headers), as * specified in the [Fetch Spec](https://fetch.spec.whatwg.org/#headers-class). * * The only known difference between this `Headers` implementation and the spec is the * lack of an `entries` method. * * ### Example ([live demo](http://plnkr.co/edit/MTdwT6?p=preview)) * * ``` * import {Headers} from '@angular/http'; * * var firstHeaders = new Headers(); * firstHeaders.append('Content-Type', 'image/jpeg'); * console.log(firstHeaders.get('Content-Type')) //'image/jpeg' * * // Create headers from Plain Old JavaScript Object * var secondHeaders = new Headers({ * 'X-My-Custom-Header': 'Angular' * }); * console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular' * * var thirdHeaders = new Headers(secondHeaders); * console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular' * ``` * * @experimental */ export class Headers { /** @internal */ _headersMap: Map; constructor(headers?: Headers|{[key: string]: any}) { if (headers instanceof Headers) { this._headersMap = new Map((headers)._headersMap); return; } this._headersMap = new Map(); if (isBlank(headers)) { return; } // headers instanceof StringMap StringMapWrapper.forEach(headers, (v: any, k: string) => { this._headersMap.set(normalize(k), isListLikeIterable(v) ? v : [v]); }); } /** * Returns a new Headers instance from the given DOMString of Response Headers */ static fromResponseHeaderString(headersString: string): Headers { let headers = new Headers(); headersString.split('\n').forEach(line => { const index = line.indexOf(':'); if (index > 0) { const key = line.substring(0, index); const value = line.substring(index + 1).trim(); headers.set(key, value); } }); return headers; } /** * Appends a header to existing list of header values for a given header name. */ append(name: string, value: string): void { name = normalize(name); var mapName = this._headersMap.get(name); var list = isListLikeIterable(mapName) ? mapName : []; list.push(value); this._headersMap.set(name, list); } /** * Deletes all header values for the given name. */ delete (name: string): void { this._headersMap.delete(normalize(name)); } forEach(fn: (values: string[], name: string, headers: Map) => void): void { this._headersMap.forEach(fn); } /** * Returns first header that matches given name. */ get(header: string): string { return ListWrapper.first(this._headersMap.get(normalize(header))); } /** * Check for existence of header by given name. */ has(header: string): boolean { return this._headersMap.has(normalize(header)); } /** * Provides names of set headers */ keys(): string[] { return MapWrapper.keys(this._headersMap); } /** * Sets or overrides header value for given name. */ set(header: string, value: string|string[]): void { var list: string[] = []; if (isListLikeIterable(value)) { var pushValue = (value).join(','); list.push(pushValue); } else { list.push(value); } this._headersMap.set(normalize(header), list); } /** * Returns values of all headers. */ values(): string[][] { return MapWrapper.values(this._headersMap); } /** * Returns string of all headers. */ toJSON(): {[key: string]: any} { let serializableHeaders = {}; this._headersMap.forEach((values: string[], name: string) => { let list: any[] /** TODO #9100 */ = []; iterateListLike( values, (val: any /** TODO #9100 */) => list = ListWrapper.concat(list, val.split(','))); (serializableHeaders as any /** TODO #9100 */)[normalize(name)] = list; }); return serializableHeaders; } /** * Returns list of header values for a given name. */ getAll(header: string): string[] { var headers = this._headersMap.get(normalize(header)); return isListLikeIterable(headers) ? headers : []; } /** * This method is not implemented. */ entries() { throw new Error('"entries" method is not implemented on Headers class'); } } // "HTTP character sets are identified by case-insensitive tokens" // Spec at https://tools.ietf.org/html/rfc2616 // This implementation is same as NodeJS. // see https://nodejs.org/dist/latest-v6.x/docs/api/http.html#http_message_headers function normalize(name: string): string { return name.toLowerCase(); }