Add TypeScript types for observer parameters. #5359
Conversation
aomarks
commented
Sep 15, 2018
•
aomarks
commented
- PolymerDeepPropertyChange for .* observers.
- PolymerSpliceChange and PolymerSplice for .splices observers.
- Parameterized for the property/path types.
- Matches the name of the interfaces in polymer-externs.js.
- Documentation mostly copy/pasted from https://www.polymer-project.org/3.0/docs/devguide/model-data.
- PolymerDeepPropertyChange for .* observers. - PolymerSpliceChange and PolymerSplice for .splices observers. - Parameterized for the property/path types. - Matches the name of the interfaces in polymer-externs.js.
aomarks
requested review from
dfreedm,
kevinpschaaf and
sorvell
as code owners
interfaces.d.ts
Outdated
| * A record of changes made to an array. | ||
| * @template T The type of the array being observed. | ||
| */ | ||
| export interface PolymerSplice<T extends Array<{}>> { |
There was a problem hiding this comment.
Prefer unknown over {} as {} is non-nullable. T extends Array<unknown>
There was a problem hiding this comment.
unknown isn't in g3 yet, how about {}|null|undefined for now? I think any is actually safe here too, because I think in this context (constraining by supertype), the any wouldn't leak anywhere (but I would avoid it just so linters don't complain)?
There was a problem hiding this comment.
{}|null|undefined is good.
You're right about any, I'd just like to avoid using it as much as possible.
interfaces.d.ts
Outdated
| * array. | ||
| * @template T The type of the array being observed. | ||
| */ | ||
| export interface PolymerSpliceChange<T extends Array<{}>> { |
It's a module so it's importable, no globals here. Users import from |
Done. |
