BREAKING(yaml): replace YamlError
with SyntaxError
in parse()
#5446
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.
What's changed
parse()
now throwsSyntaxError
instead ofYamlError
. No changes in behavior have been made.Motivation
This change was made to align
@std/yaml
with otherparse()
functions in the Standard Library, such as in@std/csv
and@std/toml
, andJSON.parse()
, which all throwSyntaxError
. This will also result in a slightly smaller API surface and allows the user to more easily differentiate betweenparse()
andstringify()
errors (stringify()
will soon throwTypeError
).Migration guide
To migrate, compare against
SyntaxError
instead ofYamlError
when error-handlingparse()
.Related
Towards #5340