revert: docs(common): add `HttpParamsOptions` to the public API (#20332)

This reverts commit 7b7757dd3d.
This commit is contained in:
Matias Niemelä 2018-03-26 14:43:14 -04:00
parent 7b7757dd3d
commit bf6a416bce
3 changed files with 20 additions and 23 deletions

View File

@ -12,7 +12,7 @@ import {concatMap, filter, map} from 'rxjs/operators';
import {HttpHandler} from './backend';
import {HttpHeaders} from './headers';
import {HttpParams} from './params';
import {HttpParams, HttpParamsOptions} from './params';
import {HttpRequest} from './request';
import {HttpEvent, HttpResponse} from './response';
@ -361,7 +361,7 @@ export class HttpClient {
if (options.params instanceof HttpParams) {
params = options.params;
} else {
params = new HttpParams({fromObject: options.params});
params = new HttpParams({ fromObject: options.params } as HttpParamsOptions);
}
}

View File

@ -73,6 +73,21 @@ interface Update {
op: 'a'|'d'|'s';
}
/** Options used to construct an `HttpParams` instance. */
export interface HttpParamsOptions {
/**
* String representation of the HTTP params in URL-query-string format. Mutually exclusive with
* `fromObject`.
*/
fromString?: string;
/** Object map of the HTTP params. Mutally exclusive with `fromString`. */
fromObject?: {[param: string]: string | string[]};
/** Encoding codec used to parse and serialize the params. */
encoder?: HttpParameterCodec;
}
/**
* An HTTP request/response body that represents serialized parameters,
* per the MIME type `application/x-www-form-urlencoded`.
@ -87,19 +102,7 @@ export class HttpParams {
private updates: Update[]|null = null;
private cloneFrom: HttpParams|null = null;
constructor(options = {} as {
/**
* String representation of the HTTP params in URL-query-string format. Mutually exclusive with
* `fromObject`.
*/
fromString?: string;
/** Object map of the HTTP params. Mutally exclusive with `fromString`. */
fromObject?: {[param: string]: string | string[]};
/** Encoding codec used to parse and serialize the params. */
encoder?: HttpParameterCodec;
}) {
constructor(options: HttpParamsOptions = {} as HttpParamsOptions) {
this.encoder = options.encoder || new HttpUrlEncodingCodec();
if (!!options.fromString) {
if (!!options.fromObject) {
@ -183,7 +186,7 @@ export class HttpParams {
}
private clone(update: Update): HttpParams {
const clone = new HttpParams({encoder: this.encoder});
const clone = new HttpParams({ encoder: this.encoder } as HttpParamsOptions);
clone.cloneFrom = this.cloneFrom || this;
clone.updates = (this.updates || []).concat([update]);
return clone;

View File

@ -1580,13 +1580,7 @@ export interface HttpParameterCodec {
/** @stable */
export declare class HttpParams {
constructor(options?: {
fromString?: string | undefined;
fromObject?: {
[param: string]: string | string[];
} | undefined;
encoder?: HttpParameterCodec | undefined;
});
constructor(options?: HttpParamsOptions);
append(param: string, value: string): HttpParams;
delete(param: string, value?: string): HttpParams;
get(param: string): string | null;