refactor(xml-helpers): document & check function signature types - Githubissues

apache / cordova-common

Apache Cordova Common Tooling Library

https://cordova.apache.org/

Apache License 2.0

39 stars 46 forks source link

refactor(xml-helpers): document & check function signature types #160

Closed raphinesse closed 2 years ago

raphinesse commented 3 years ago

Motivation and Context

This PR adds type documentation to the util/xml-helpers module to more clearly document the interface of the module.

I already added this kind of type documentation before (to munge-util in #127). The types' correctness can be checked using TypeScript tooling.

Description

use ES6 method syntax (because VSCode generated a nicer starting point that way)
document & check function signature types
satisfy TS type checks: in a few cases our code was not 100% in line with the elementtree types. However both the old and new version should behave identically with regards to our use-cases

Testing

Checked type correctness of module using VSCode

raphinesse commented 3 years ago

Last call for reviews or objections.