From a9545aba4df81a10de6692619f06b5d0c11614a8 Mon Sep 17 00:00:00 2001
From: George Kalpakas <kalpakas.g@gmail.com>
Date: Fri, 10 Nov 2017 13:52:21 +0200
Subject: [PATCH] docs(common): add `HttpParamsOptions` to the public API
(#20332)
Fixes #20276
PR Close #20332
---
packages/common/http/src/client.ts | 4 ++--
packages/common/http/src/params.ts | 31 +++++++++++--------------
tools/public_api_guard/common/http.d.ts | 8 ++++++-
3 files changed, 23 insertions(+), 20 deletions(-)
diff --git a/packages/common/http/src/client.ts b/packages/common/http/src/client.ts
index 896974ddb1..77c82fe4db 100644
--- a/packages/common/http/src/client.ts
+++ b/packages/common/http/src/client.ts
@@ -15,7 +15,7 @@ import {map} from 'rxjs/operator/map';
import {HttpHandler} from './backend';
import {HttpHeaders} from './headers';
-import {HttpParams, HttpParamsOptions} from './params';
+import {HttpParams} from './params';
import {HttpRequest} from './request';
import {HttpEvent, HttpResponse} from './response';
@@ -364,7 +364,7 @@ export class HttpClient {
if (options.params instanceof HttpParams) {
params = options.params;
} else {
- params = new HttpParams({ fromObject: options.params } as HttpParamsOptions);
+ params = new HttpParams({fromObject: options.params});
}
}
diff --git a/packages/common/http/src/params.ts b/packages/common/http/src/params.ts
index 170f151fe6..555f45efd2 100755
--- a/packages/common/http/src/params.ts
+++ b/packages/common/http/src/params.ts
@@ -73,21 +73,6 @@ 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`.
@@ -102,7 +87,19 @@ export class HttpParams {
private updates: Update[]|null = null;
private cloneFrom: HttpParams|null = null;
- constructor(options: HttpParamsOptions = {} as HttpParamsOptions) {
+ 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;
+ }) {
this.encoder = options.encoder || new HttpUrlEncodingCodec();
if (!!options.fromString) {
if (!!options.fromObject) {
@@ -186,7 +183,7 @@ export class HttpParams {
}
private clone(update: Update): HttpParams {
- const clone = new HttpParams({ encoder: this.encoder } as HttpParamsOptions);
+ const clone = new HttpParams({encoder: this.encoder});
clone.cloneFrom = this.cloneFrom || this;
clone.updates = (this.updates || []).concat([update]);
return clone;
diff --git a/tools/public_api_guard/common/http.d.ts b/tools/public_api_guard/common/http.d.ts
index fd066926af..d341eadb45 100644
--- a/tools/public_api_guard/common/http.d.ts
+++ b/tools/public_api_guard/common/http.d.ts
@@ -1580,7 +1580,13 @@ export interface HttpParameterCodec {
/** @stable */
export declare class HttpParams {
- constructor(options?: HttpParamsOptions);
+ constructor(options?: {
+ fromString?: string | undefined;
+ fromObject?: {
+ [param: string]: string | string[];
+ } | undefined;
+ encoder?: HttpParameterCodec | undefined;
+ });
append(param: string, value: string): HttpParams;
delete(param: string, value?: string): HttpParams;
get(param: string): string | null;