v0.1.0

[dillonredding]

See CHANGELOG.md

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@b8df645). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head a6a349d differs from pull request most recent head 63896ca. Consider uploading reports for the commit 63896ca to get more accurate results

@@           Coverage Diff           @@
##             main       #1   +/-   ##
=======================================
  Coverage        ?   98.75%           
=======================================
  Files           ?        3           
  Lines           ?       80           
  Branches        ?       14           
=======================================
  Hits            ?       79           
  Misses          ?        1           
  Partials        ?        0           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b8df645...63896ca. Read the comment docs.

[SeeSharpCode]

isSiren() helper method would be useful.

[dillonredding]

Seems odd to have that without isJson(), isText(), etc. helpers, which aren't part of the Response interface. What would isSiren() do exactly? Keep in mind, that the body is a stream, so once it's read, it cannot be read again.

[SeeSharpCode]

It would check that the Content-Type header is Siren (maybe isContentTypeSiren()). That will probably be a common check.

[dillonredding]

I don't believe checking the Content-Type header is sufficient, per Section 3.1.1.5 of RFC 7231:

A sender that generates a message containing a payload body SHOULD
generate a Content-Type header field in that message unless the
intended media type of the enclosed representation is unknown to the
sender. If a Content-Type header field is not present, the recipient
MAY either assume a media type of "application/octet-stream"
([RFC2046], Section 4.5.1) or examine the data to determine its type.

The last piece ("examine the data to determine its type") is where it gets tricky with the body stream. Since there are no other isMediaType() helpers, I'm not sure there's much value here. If it's not Siren, users will have to check the Content-Type using the typical headers.get('Content-Type') anyway. OTOH, it might be useful to have a constant for the Siren media type, so the check would be less error-prone. Something like this, maybe?

if (response.headers.get('Content-Type') === MediaType.Siren) {
 const entity = await response.siren();
}