Skip to content

Commit

Permalink
Clarify what parts of the standard we don't implement
Browse files Browse the repository at this point in the history
Closes #661
  • Loading branch information
mislav committed Sep 18, 2018
1 parent bfaffec commit 473238b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ <h1>Fetch</h1>

<p>
This documents the polyfillable parts of the
<a href="https://fetch.spec.whatwg.org/">WHATWG fetch spec</a>.
<a href="https://fetch.spec.whatwg.org/">WHATWG Fetch standard</a>.
See <a href="#caveats">Caveats</a> for notable exceptions.
</p>

<p>
Expand Down Expand Up @@ -138,7 +139,7 @@ <h3 id="options">Options</h3>
<li><code>method</code> (String) - HTTP request method. Default: <code>"GET"</code></li>
<li><code>body</code> (String, <a href="#request-body">body types</a>) - HTTP request body</li>
<li><code>headers</code> (Object, <a href="#Headers">Headers</a>) - Default: <code>{}</code></li>
<li id="credentials"><code>credentials</code> (String) - Authentication credentials mode. Default: <code>"same-origin"</code>
<li id="credentials"><code>credentials</code> (String) - Authentication credentials mode. Default: <code>"omit"</code>
<ul>
<li><code>"omit"</code> - don't include authentication credentials (e.g. cookies) in the request</li>
<li><code>"same-origin"</code> - include credentials in requests to the same site</li>
Expand Down Expand Up @@ -299,8 +300,10 @@ <h2 id="error">Error</h2>
<h2 id="caveats">Caveats</h2>

<p>
<span class="name">fetch</span> isn't able to polyfill the entire standard.
Some notable differences include:
The <a href="https://github.com/github/fetch">whatwg-fetch polyfill</a> isn't
able nor does it aim to implement the entire WHATWG Fetch standard, since some
of the standard features would be non-trivial or otherwise unfeasible to
implement. Notable examples include:
</p>
<ul>
<li>Inability to <a href="https://github.com/github/fetch/issues/137">set the redirect mode</a></li>
Expand Down

0 comments on commit 473238b

Please sign in to comment.