feat: support for full result object in node streams #1015
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
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.
Why these changes
When using the DuplexStreamStreamer in node, the callback only receives the row data, instead of the full parse result object, however the library still generates per-row errors (if any) and metadata internally, which are useful when processing. For example, it would be helpful to be able to validate
meta.renamedHeadersor check thaterrorsis empty for the given row.What does this PR change
Adds an optional configuration setting to provide the full result object to the callback (and corresponding tests). This allows PapaParse users to opt-in, since changing default behavior would be breaking. As with existing behavior when using streams, the result object (including both the
errorarray andmetaobject) are atomic to the individual row sent to the callback.Resolves #754