refactor(xml-helpers): document & check function signature types #160
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Last call for reviews or objections. |
- `et.ElementText` is not always a string but always has `#toString` - `et.ElementTag` is not always a string, but converting it to one should be sufficient for our purposes - `et.Element` is not a constructor, so it should be called w/out new
raphinesse
force-pushed
the
xml-helpers-types
branch
from
71d46ab
to
93cae11
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This PR adds type documentation to the
util/xml-helpersmodule to more clearly document the interface of the module.I already added this kind of type documentation before (to
munge-utilin #127). The types' correctness can be checked using TypeScript tooling.Description
elementtreetypes. However both the old and new version should behave identically with regards to our use-casesTesting
Checked type correctness of module using VSCode