honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add details to HttpUrlEncodingCodec API description (#28507) 

PR Close #28507
This commit is contained in:
Vani 2019-02-03 17:39:28 -08:00 committed by Miško Hevery
parent 2b836c81a2
commit 416b0d29b9
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
packages/common/http/src/params.ts
View File

@ -14,16 +14,19 @@
* @publicApi * @publicApi
**/ **/
export interface HttpParameterCodec { export interface HttpParameterCodec {
encodeKey(key: string): string; encodeKey(key: string):string;
encodeValue(value: string): string; encodeValue(value: string):string;
decodeKey(key: string): string; decodeKey(key: string):string;
decodeValue(value: string): string; decodeValue(value: string):string;
} }
/** /**
* A `HttpParameterCodec` that uses `encodeURIComponent` and `decodeURIComponent` to * A `HttpParameterCodec` that uses `encodeURIComponent` and `decodeURIComponent` to
* serialize and parse URL parameter keys and values. * serialize and parse URL parameter keys and values. If URL query parameters are
* passed without encoding, they might be misinterpreted at the receiving end. Use the
* `HttpParameterCodec` to encode the query-string values. The same class can be used to decode the
* encoded query-string values.
* *
* @publicApi * @publicApi
*/ */