docs: update docs

Author: TomokiMiyauci

README.md

@@ -1,17 +1,20 @@
 # http-utils
 
-HTTP utility collection for Fetch API.
+[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno)](https://deno.land/x/http_utils)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/httpland/http_utils)](https://github.com/httpland/http_utils/releases)
+[![codecov](https://codecov.io/github/httpland/http-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/httpland/http-utils)
+[![GitHub](https://img.shields.io/github/license/httpland/http-utils)](https://github.com/httpland/http-utils/blob/main/LICENSE)
+
+[![test](https://github.com/httpland/http-utils/actions/workflows/test.yaml/badge.svg)](https://github.com/httpland/http-utils/actions/workflows/test.yaml)
+[![NPM](https://nodei.co/npm/@httpland/http-utils.png?mini=true)](https://nodei.co/npm/@httpland/http-utils/)
 
-A collection of modules with one or more of the following characteristics:
+HTTP utility collection for Fetch API.
 
-- Common to many projects
-- Too difficult to classify
-- Too small
+## Request
 
-Each module will be split into a separate repository when it becomes
-classifiable.
+Utilities for `Request` object.
 
-## equalsRequest
+### equalsRequest
 
 Check two `Request` fields equality.
 
@@ -46,7 +49,7 @@ assert(
 );
 ```
 
-### Throwing error
+#### Throwing error
 
 In strict mode, if request body has already been read.
 
@@ -62,7 +65,7 @@ assert(request.bodyUsed);
 assertThrows(() => equalsRequest(request, request, true));
 ```
 
-## isRequest
+### isRequest
 
 Whether the input is `Request` or not.
 
@@ -75,7 +78,77 @@ assertEquals(isRequest({}), false);
 assertEquals(isRequest(null), false);
 ```
 
-## equalsHeaders
+## Response
+
+Utilities for `Response` object.
+
+### equalsResponse
+
+Check two `Response` fields equality.
+
+```ts
+import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
+import { assert } from "https://deno.land/std@$VERSION/testing/asserts.ts";
+
+assert(
+  equalsResponse(
+    new Response(null, { status: 204, headers: { "content-length": "0" } }),
+    new Response(null, { status: 204, headers: { "content-length": "0" } }),
+  ),
+);
+```
+
+If you also want to check the equivalence of the body, set the mode to strict.
+
+```ts
+import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
+import { assert } from "https://deno.land/std@$VERSION/testing/asserts.ts";
+
+assert(
+  await equalsResponse(
+    new Response("test1", { status: 200, headers: { "content-length": "5" } }),
+    new Response("test2", { status: 200, headers: { "content-length": "5" } }),
+    true,
+  ),
+);
+```
+
+#### Throwing error
+
+In strict mode, if response body has already been read.
+
+```ts
+import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
+import {
+  assert,
+  assertThrows,
+} from "https://deno.land/std@$VERSION/testing/asserts.ts";
+
+const response = new Response("");
+await response.text();
+
+assert(response.bodyUsed);
+assertThrows(() => equalsResponse(response, response, true));
+```
+
+### isResponse
+
+Whether the input is `Response` or not.
+
+```ts
+import { isResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
+import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts";
+
+assertEquals(isResponse(new Response()), true);
+assertEquals(isResponse({}), false);
+assertEquals(isResponse(null), false);
+```
+
+## Headers
+
+Utilities for `Headers` object.
+
+### equalsHeaders
 
 Check two `Headers` field name and field value equality.
 
@@ -93,7 +166,7 @@ assertEquals(
 );
 ```
 
-## filterKeys
+### filterKeys
 
 Returns a new `Headers` with all entries of the given headers except the ones
 that have a key(header name or field name) that does not match the given
@@ -115,7 +188,7 @@ assert(headers.has("content-type"));
 assert(!headers.has("date"));
 ```
 
-## isMessageMetadataHeader
+### isMessageMetadataHeader
 
 Whether the input is [MessageMetadataHeader](#messagemetadataheader) or not.
 
@@ -127,7 +200,7 @@ assert(isMessageMetadataHeader("date"));
 assert(!isMessageMetadataHeader("<others>"));
 ```
 
-## isMessageForwardingHeader
+### isMessageForwardingHeader
 
 Whether the input is [MessageForwardingHeader](#messageforwardingheader) or not.
 
@@ -139,7 +212,7 @@ assert(isMessageForwardingHeader("connection"));
 assert(!isMessageForwardingHeader("<others>"));
 ```
 
-## isRepresentationHeader
+### isRepresentationHeader
 
 Whether the input is [RepresentationHeader](#representationheader) or not.
 
@@ -151,7 +224,7 @@ assert(isRepresentationHeader("content-type"));
 assert(!isRepresentationHeader("<others>"));
 ```
 
-## isAuthenticationHeader
+### isAuthenticationHeader
 
 Whether the input is [AuthenticationHeader](#authenticationheader) or not.
 
@@ -163,7 +236,7 @@ assert(isAuthenticationHeader("authorization"));
 assert(!isAuthenticationHeader("<others>"));
 ```
 
-## isContentNegotiationHeader
+### isContentNegotiationHeader
 
 Whether the input is [ContentNegotiationHeader](#contentnegotiationheader) or
 not.
@@ -176,7 +249,7 @@ assert(isContentNegotiationHeader("accept"));
 assert(!isContentNegotiationHeader("<others>"));
 ```
 
-## isConditionalHeader
+### isConditionalHeader
 
 Whether the input is [ConditionalHeader](#conditionalheader) or not.
 
@@ -188,7 +261,7 @@ assert(isConditionalHeader("if-match"));
 assert(!isConditionalHeader("<others>"));
 ```
 
-## isRangeHeader
+### isRangeHeader
 
 Whether the input is [RangeHeader](#rangeheader) or not.
 
@@ -200,7 +273,7 @@ assert(isRangeHeader("range"));
 assert(!isRangeHeader("<others>"));
 ```
 
-## isCachingHeader
+### isCachingHeader
 
 Whether the input is [CachingHeader](#cachingheader) or not.
 
@@ -212,7 +285,7 @@ assert(isCachingHeader("age"));
 assert(!isCachingHeader("<others>"));
 ```
 
-## MessageMetadataHeader
+### MessageMetadataHeader
 
 HTTP Message Metadata header fields.
 
@@ -229,7 +302,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(MessageMetadataHeader.Date, "date");
 ```
 
-## MessageForwardingHeader
+### MessageForwardingHeader
 
 HTTP Message Forwarding header fields.
 
@@ -247,7 +320,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(MessageForwardingHeader.Via, "via");
 ```
 
-## RepresentationHeader
+### RepresentationHeader
 
 HTTP representation data and metadata header fields.
 
@@ -269,7 +342,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(RepresentationHeader.ContentType, "content-type");
 ```
 
-## AuthenticationHeader
+### AuthenticationHeader
 
 HTTP Authentication header fields.
 
@@ -290,7 +363,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(AuthenticationHeader.Authorization, "authorization");
 ```
 
-## ContentNegotiationHeader
+### ContentNegotiationHeader
 
 HTTP content negotiation header fields.
 
@@ -310,7 +383,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(ContentNegotiationHeader.Accept, "accept");
 ```
 
-## ConditionalHeader
+### ConditionalHeader
 
 HTTP conditional requests header fields.
 
@@ -330,7 +403,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(ConditionalHeader.IfNoneMatch, "if-none-match");
 ```
 
-## RangeHeader
+### RangeHeader
 
 HTTP range requests header fields.
 
@@ -348,7 +421,7 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(RangeHeader.Range, "range");
 ```
 
-## CachingHeader
+### CachingHeader
 
 HTTP Caching header fields.
 
@@ -365,69 +438,11 @@ import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
 assertEquals(CachingHeader.CacheControl, "cache-control");
 ```
 
-## equalsResponse
-
-Check two `Response` fields equality.
-
-```ts
-import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
-import { assert } from "https://deno.land/std@$VERSION/testing/asserts.ts";
-
-assert(
-  equalsResponse(
-    new Response(null, { status: 204, headers: { "content-length": "0" } }),
-    new Response(null, { status: 204, headers: { "content-length": "0" } }),
-  ),
-);
-```
-
-If you also want to check the equivalence of the body, set the mode to strict.
-
-```ts
-import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
-import { assert } from "https://deno.land/std@$VERSION/testing/asserts.ts";
-
-assert(
-  await equalsResponse(
-    new Response("test1", { status: 200, headers: { "content-length": "5" } }),
-    new Response("test2", { status: 200, headers: { "content-length": "5" } }),
-    true,
-  ),
-);
-```
+## Method
 
-### Throwing error
+Utilities for HTTP method.
 
-In strict mode, if response body has already been read.
-
-```ts
-import { equalsResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
-import {
-  assert,
-  assertThrows,
-} from "https://deno.land/std@$VERSION/testing/asserts.ts";
-
-const response = new Response("");
-await response.text();
-
-assert(response.bodyUsed);
-assertThrows(() => equalsResponse(response, response, true));
-```
-
-## isResponse
-
-Whether the input is `Response` or not.
-
-```ts
-import { isResponse } from "https://deno.land/x/http_utils@$VERSION/response.ts";
-import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts";
-
-assertEquals(isResponse(new Response()), true);
-assertEquals(isResponse({}), false);
-assertEquals(isResponse(null), false);
-```
-
-## isSafeMethod
+### isSafeMethod
 
 Whether the method is safe method or not.
 
@@ -444,7 +459,7 @@ assert(isSafeMethod("OPTIONS"));
 assert(isSafeMethod("TRACE"));
 ```
 
-## isIdempotentMethod
+### isIdempotentMethod
 
 Whether the method is idempotent method or not.
 
@@ -460,7 +475,7 @@ assert(isIdempotentMethod("PUT"));
 assert(isIdempotentMethod("DELETE"));
 ```
 
-## isRetrieveMethod
+### isRetrieveMethod
 
 Whether the method is retrieve method or not.
 
@@ -478,7 +493,16 @@ assert(isRetrieveMethod("HEAD"));
 assert(!isRetrieveMethod("POST"));
 ```
 
-## withHeader
+## Message
+
+Utilities for HTTP message.
+
+HTTP message is following union types:
+
+- `Request`
+- `Response`
+
+### withHeader
 
 Return an instance with the provided value replacing the specified header. There
 are no side effects on the original target.