Merge pull request #2 from httpland/beta

Beta

Author: TomokiMiyauci

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.1.0-beta.1](https://github.com/httpland/chain-handler/compare/1.0.0...1.1.0-beta.1) (2023-02-08)
+
+
+### Features
+
+* **types.ts:** split interface and export types ([02b49b9](https://github.com/httpland/chain-handler/commit/02b49b99cac229c1dc9ed7c64690df6c0fbe1e1e))
+
 # 1.0.0 (2023-02-06)
 
 

_dev_deps.ts

@@ -1,9 +1,9 @@
 export {
   assertEquals,
   assertNotEquals,
-} from "https://deno.land/std@0.176.0/testing/asserts.ts";
+} from "https://deno.land/std@0.177.0/testing/asserts.ts";
 export {
   assertSpyCalls,
   spy,
-} from "https://deno.land/std@0.176.0/testing/mock.ts";
-export { describe, it } from "https://deno.land/std@0.176.0/testing/bdd.ts";
+} from "https://deno.land/std@0.177.0/testing/mock.ts";
+export { describe, it } from "https://deno.land/std@0.177.0/testing/bdd.ts";

chain.ts

@@ -1,7 +1,12 @@
 // Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
-import type { Chainable, ChainableHandler, OptionalHandler } from "./types.ts";
+import type {
+  Chainable,
+  ChainableHandler,
+  OptionalHandler,
+  Responsive,
+} from "./types.ts";
 
 /** Immutable chain builder for HTTP handlers.
  *
@@ -38,7 +43,7 @@ import type { Chainable, ChainableHandler, OptionalHandler } from "./types.ts";
  * assertEquals(response.headers.get("server"), "deno")
  * ```
  */
-export class Chain implements Chainable {
+export class Chain implements Chainable, Responsive {
   #handlers: readonly ChainableHandler[] = [];
 
   /**
@@ -48,16 +53,24 @@ export class Chain implements Chainable {
     this.#handlers = init ?? [];
   }
 
-  /**
-   * @param handlers
+  /** Register chainable HTTP handlers.
+   * @param handlers HTTP chainable handlers.
+   *
+   * @example
+   * ```ts
+   * import { Chain } from "https://deno.land/x/chain_handler@$VERSION/mod.ts";
+   *
+   * const chain = new Chain().next((request, next) => next(), () => new Response("hello"))
+   * ```
    */
   readonly next = (...handlers: readonly ChainableHandler[]): this => {
     this.#handlers = this.#handlers.concat(handlers);
 
     return this;
   };
 
-  /**
+  /** All registered handlers.
+   *
    * @example
    * ```ts
    * import { Chain } from "https://deno.land/x/chain_handler@$VERSION/mod.ts";
@@ -73,6 +86,16 @@ export class Chain implements Chainable {
   /**
    * @param request `Request` object. The `Request` is cloned and not mutate.
    * @param defaultResponse The default `Response` object. Change the response when the {@link handlers} is empty.
+   *
+   * @example
+   * ```ts
+   * import { Chain } from "https://deno.land/x/chain_handler@$VERSION/mod.ts";
+   * import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
+   *
+   * const chain = new Chain()
+   * const response = await chain.respond(new Request("http://localhost"))
+   * assertEquals(response.status, 404)
+   * ```
    */
   readonly respond = (
     request: Request,

deno.lock

@@ -2,5 +2,10 @@
 // This module is browser compatible.
 
 export { Chain, chain } from "./chain.ts";
-export type { Chainable, ChainableHandler, OptionalHandler } from "./types.ts";
+export type {
+  Chainable,
+  ChainableHandler,
+  OptionalHandler,
+  Responsive,
+} from "./types.ts";
 export type { Handler } from "./deps.ts";

mod.ts

@@ -1,6 +1,6 @@
 {
   "imports": {
     "https://deno.land/x/chain_handler@$VERSION/": "./",
-    "https://deno.land/std/": "https://deno.land/std@0.176.0/"
+    "https://deno.land/std/": "https://deno.land/std@0.177.0/"
   }
 }

test_import_map.json

@@ -24,10 +24,12 @@ export interface OptionalHandler {
 export interface Chainable {
   /** Register chainable HTTP handlers. */
   readonly next: (...handlers: readonly ChainableHandler[]) => this;
+}
 
+/** HTTP responsive API.
+ * Accept `Request` and respond `Response`.
+ */
+export interface Responsive {
   /** Respond `Response` from `Request`. */
   readonly respond: Handler;
-
-  /** All registered handlers. */
-  readonly handlers: readonly ChainableHandler[];
 }