Change XMLBuilder typings to expose correct function name #396
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.
The typings defined
parse
, even if the actual class exposesbuild
.Also changing the parameter name from
options
tojObj
Purpose / Goal
Improve the experience using XMLBuilder in v4 with Typescript by using the correct function name,
build
instead ofparse
.This pull request doesn't have an issue connected with it, as it's quite small.
Expected:
When using XMLBuilder with Typescript, it should suggest and accept
new Builder(options).build
Actual:
When using XMLBuilder with Typescript, it suggests and accepts
new Builder(options).parse
, which is not defined on the actual class. Attempting to usenew Builder(options).build
raises a Typescript error, and we need to use// @ts-ignore
to be able to build.Benchmarks:
Shouldn't affect performance, but just to show that I skimmed through the contribution guidelines:
Type
Please mention the type of PR
Note : Please ensure that you've read contribution guidelines before raising this PR. If your PR is in progress, please prepend
[WIP]
in PR title. Your PR will be reviewed when[WIP]
will be removed from the PR title.Bookmark this repository for further updates.