docs(common): add HttpParamsOptions to the public API

[gkalpak]

PR Checklist

• The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

[x] Documentation content changes

What is the current behavior?

HttpParamsOptions is not documented as part of the public API.
Issue Number: #20276

What is the new behavior?

HttpParamsOptions is documented as part of the public API.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[mary-poppins]

You can preview 7b3fb9b at https://pr20332-7b3fb9b.ngbuilds.io/.

[trotyl]

Shouldn't it be added to public API guard as well (by re-export in entry)? Currently it still cannot be imported via .ts file.

PS: it's also not in doc as well.

[mary-poppins]

You can preview 94e1241 at https://pr20332-94e1241.ngbuilds.io/.

[mary-poppins]

You can preview 4e8f151 at https://pr20332-4e8f151.ngbuilds.io/.

[mary-poppins]

You can preview 15a36f7 at https://pr20332-15a36f7.ngbuilds.io/.

[sunew]

Any news on this one?

[gkalpak]

/ping @alxhub

[alxhub]

Hi @gkalpak,

I actually think the right approach here is to get rid of the interface type and inline its definition into the HttpParams constructor.

[mary-poppins]

You can preview f66b3c9 at https://pr20332-f66b3c9.ngbuilds.io/.

[mary-poppins]

You can preview f1cb452 at https://pr20332-f1cb452.ngbuilds.io/.

[gkalpak]

@alxhub, PTAL

[mary-poppins]

You can preview 11cafd3 at https://pr20332-11cafd3.ngbuilds.io/.

[mhevery]

Adding doc comments does not seem to work here: https://pr20332-11cafd3.ngbuilds.io/api/common/http/HttpParams

Please file an issue with AIO

[mhevery]

http://test/OCL:184784396:BASE:185054140:1518129586003:ce069c61

[gkalpak]

Any idea on how to fix it?

[mhevery]

Here is the error:

error(s):
packages/common/http/src/params.closure.js:131: 
Originally at:
packages/common/http/src/params.ts:105: ERROR - Property disambiguator skipping all instances of property fromObject because of type {
  encoder: (module$contents$packages$common$http$src$params_HttpParameterCodec|undefined),
  fromObject: (Object<string,(Array<string>|string)>|undefined),
  fromString: (string|undefined)
} node GETPROP 131 [length: 18] [originalname: fromObject] [source_file: packages/common/http/src/params.closure.js] : (Object<string,(Array<string>|string)>|undefined). 

[gkalpak]

It seems that this error comes from here, but I have no idea how to solve it 😁
Maybe adding the interface back (and adding it to the public API - which @alxhub would prefer to avoid) would help closure disambiguate the fromObject property.

[IgorMinar]

https://test.corp.google.com/ui#id=OCL:184784396:BASE:189843746:1521593426800:63ed54f5

[matsko]

@gkalpak @alxhub @mhevery this got reveted because of G3 failures.

[gkalpak]

Resubmitted as #23015.

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}