docs: document content-type parsing in getRecord() and setRecord() - #1082
Merged
Merged
Conversation
vdusek
added
the
t-tooling
Contributor
|
See more at https://github.com/apify/apify-client-js/actions/runs/36114715259#summary-108005969222 |
This file contains hidden or 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
2 participants
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.
getRecord()keeps parsing records by content type. The Python client does the same, and Crawlee'sKeyValueStore.getValue()expects parsed JSON back, so a different default would break both for a rare case. The alternative of returning the raw body when parsing fails is also out: a JSON body truncated by a dropped connection would then come back as a string without any error.This PR documents the behavior instead. The
getRecord()JSDoc now lists the parsing rules and says that a body that doesn't parse throwsInvalidResponseBodyError, with the raw body inerror.response. It also says thatbuffer: trueskips parsing. ThesetRecord()JSDoc says a string is sent as it is even underapplication/json, so it has to be valid JSON already.Relates #1067
✍️ Drafted by Claude Code