itty-router 5.0.0-next.2 → 5.0.0-next.3

package/README.md

@@ -13,10 +13,10 @@
     <img src="https://edge.bundlejs.com/?q=itty-router/Router&badge&badge-style=flat-square" alt="bundle size" />
   </a>
   <a href="https://github.com/kwhitley/itty-router/actions/workflows/verify.yml" target="_blank">
-    <img src="https://img.shields.io/github/actions/workflow/status/kwhitley/itty-router/verify.yml?branch=v4.x&style=flat-square" alt="build status" />
+    <img src="https://img.shields.io/github/actions/workflow/status/kwhitley/itty-router/verify.yml?branch=v5.x&style=flat-square" alt="build status" />
   </a>
-  <a href="https://coveralls.io/github/kwhitley/itty-router?branch=v4.x" target="_blank">
-    <img src="https://img.shields.io/coveralls/github/kwhitley/itty-router/v4.x?style=flat-square" alt="code coverage" />
+  <a href="https://coveralls.io/github/kwhitley/itty-router?branch=v5.x" target="_blank">
+    <img src="https://img.shields.io/coveralls/github/kwhitley/itty-router/v5.x?style=flat-square" alt="code coverage" />
   </a>
   <a href="https://npmjs.com/package/itty-router" target="_blank">
     <img src="https://img.shields.io/npm/dw/itty-router?style=flat-square" alt="weekly downloads" />
@@ -47,19 +47,16 @@
 
 An ultra-tiny API microrouter, for use when [size matters](https://github.com/TigersWay/cloudflare-playground) (e.g. [Cloudflare Workers](https://developers.cloudflare.com/workers/)).
 
-
-
-
 ## Features
 
 - Tiny. Routers from [~450 bytes](https://itty.dev/itty-router/routers/ittyrouter) to a [~970 bytes](https://itty.dev/itty-router/routers/autorouter) batteries-included version (~240-500x smaller than Express.js).
+- [TypeScript](https://itty.dev/itty-router/typescript). Powerfully (and flexibly) typed for any environment.
+- [Route-parsing](https://itty.dev/itty-router/route-patterns) & [query parsing](https://itty.dev/itty-router/route-patterns#query).
+- [Middleware](https://itty.dev/itty-router/middleware). Use ours or write your own.
+- [100% Test Coverage](https://coveralls.io/github/kwhitley/itty-router?branch=v5.x). Bulletproof for production peace-of-mind.
 - Web Standards. Use it [anywhere, in any environment](https://itty.dev/itty-router/runtimes).
 - No assumptions. Return anything; pass in anything.
-- Dead-simple user-code.  We want _your_ code to be tiny too.
 - Future-proof.  HTTP methods not-yet-invented already work with it.
-- [Route-parsing](https://itty.dev/itty-router/route-patterns) & [query parsing](https://itty.dev/itty-router/route-patterns#query).
-- [Middleware](https://itty.dev/itty-router/middleware) - use ours or write your own.
-- [Supports Nesting](https://itty.dev/itty-router/nesting).
 
 ## Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "5.0.0-next.2",
+  "version": "5.0.0-next.3",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
   "main": "./index.js",
   "module": "./index.mjs",

package/types/ErrorHandler.d.ts

@@ -1,2 +1,3 @@
+import { StatusError } from '../StatusError';
 import { IRequest } from './IRequest';
-export type ErrorHandler<ErrorType = Error, RequestType = IRequest, Args extends any[] = any[]> = (response: ErrorType, request: RequestType, ...args: Args) => any;
+export type ErrorHandler<ErrorType extends Error = StatusError, RequestType = IRequest, Args extends any[] = any[]> = (error: ErrorType, request: RequestType, ...args: Args) => any;

package/types/IRequestStrict.d.ts

@@ -1,6 +1,4 @@
 export type IRequestStrict = {
-    method: string;
-    url: string;
     route: string;
     params: {
         [key: string]: string;

package/types/IttyRouterOptions.d.ts

@@ -1,5 +1,6 @@
+import { GenericTraps } from './GenericTraps';
 import { RouteEntry } from './RouteEntry';
 export type IttyRouterOptions = {
     base?: string;
     routes?: RouteEntry[];
-} & Record<string, any>;
+} & GenericTraps;

package/types/IttyRouterType.d.ts

@@ -1,12 +1,13 @@
-import { CustomRoutes } from './CustomRoutes';
+import { GenericTraps } from './GenericTraps';
 import { IRequest } from './IRequest';
 import { RequestLike } from './RequestLike';
 import { Route } from './Route';
 import { RouteEntry } from './RouteEntry';
-export type IttyRouterType<R = IRequest, A extends any[] = any[], Output = any> = {
+import { CustomRoutes } from './CustomRoutes';
+export type IttyRouterType<R = IRequest, A extends any[] = any[], ResponseType = any> = {
     __proto__: IttyRouterType<R>;
     routes: RouteEntry[];
-    fetch: <Args extends any[] = A>(request: RequestLike, ...extra: Args) => Promise<Output>;
+    fetch: <Args extends any[] = A>(request: RequestLike, ...extra: Args) => Promise<ResponseType>;
     all: Route<R, A>;
     delete: Route<R, A>;
     get: Route<R, A>;
@@ -15,4 +16,4 @@ export type IttyRouterType<R = IRequest, A extends any[] = any[], Output = any>
     patch: Route<R, A>;
     post: Route<R, A>;
     put: Route<R, A>;
-} & CustomRoutes<Route<R, A>>;
+} & CustomRoutes<Route<R, A>> & GenericTraps;

package/types/ResponseFormatter.d.ts

@@ -1,3 +1 @@
-export interface ResponseFormatter {
-    (body?: any, options?: ResponseInit): Response;
-}
+export type ResponseFormatter = (body?: any, options?: ResponseInit) => Response;

package/types/RouterType.d.ts

@@ -3,8 +3,8 @@ import { IRequest } from './IRequest';
 import { IttyRouterType } from './IttyRouterType';
 import { RequestHandler } from './RequestHandler';
 import { ResponseHandler } from './ResponseHandler';
-export type RouterType<R = IRequest, Args extends any[] = any[]> = {
+export type RouterType<R = IRequest, Args extends any[] = any[], ResponseType = any> = {
     before?: RequestHandler<any>[];
     catch?: ErrorHandler;
     finally?: ResponseHandler[];
-} & IttyRouterType<R, Args>;
+} & IttyRouterType<R, Args, ResponseType>;