Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify in Body.json() doc that it returns a JS object, not JSON #3098

Merged
merged 3 commits into from
Mar 16, 2021
Merged

Clarify in Body.json() doc that it returns a JS object, not JSON #3098

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28f382d
It is very confusing
KennethKinLum Mar 13, 2021
a42cffa
Update index.html
KennethKinLum Mar 13, 2021
dfef4cd
Add a clarification and also update existing text
sideshowbarker Mar 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions files/en-us/web/api/body/json/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@
<div>{{APIRef("Fetch API")}}</div>

<p>The <strong><code>json()</code></strong> method of the {{DOMxRef("Body")}} mixin takes
a {{DOMxRef("Response")}} stream and reads it to completion. It returns a promise that
resolves with the result of parsing the body text as {{JSxRef("JSON")}}.</p>
a {{DOMxRef("Response")}} stream and reads it to completion. It returns a promise which
resolves with a JavaScript object that is the result of parsing the body text as {{JSxRef("JSON")}}.</p>

<p>Note that despite the method being named <code>json()</code>, the result is not JSON but is instead the result of taking JSON as input and parsing it to produce a JavaScript object.</p>

<h2 id="Syntax">Syntax</h2>

Expand Down