itty-router - npm Package Compare versions

Comparing version 5.0.12 to 5.0.13

AutoRouter.d.ts

 import { AutoRouterOptions, AutoRouterType, IRequest } from './types';
-export declare const AutoRouter: <RequestType extends IRequest = IRequest, Args extends any[] = any[], ResponseType = any>({ format, missing, finally: f, before, ...options }?: AutoRouterOptions) => AutoRouterType<RequestType, Args, ResponseType>;
+export declare const AutoRouter: <RequestType extends IRequest = IRequest, Args extends any[] = any[], ResponseType = any>({ format, missing, finally: f, before, ...options }?: AutoRouterOptions<RequestType, Args, ResponseType>) => AutoRouterType<RequestType, Args, ResponseType>;

IttyRouter.d.ts

 import { IRequest, IttyRouterOptions, IttyRouterType } from './types';
-export declare const IttyRouter: <RequestType extends IRequest = IRequest, Args extends any[] = any[], ResponseType = any, GlobalRequestType = RequestType>({ base, routes, ...other }?: IttyRouterOptions) => IttyRouterType<RequestType, Args, ResponseType, GlobalRequestType>;
+export declare const IttyRouter: <RequestType extends IRequest = IRequest, Args extends any[] = any[], ResponseType = any>({ base, routes, ...other }?: IttyRouterOptions) => IttyRouterType<RequestType, Args, ResponseType>;

package.json

 {
   "name": "itty-router",
-  "version": "5.0.12",
+  "version": "5.0.13",
   "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -34,10 +34,7 @@ <p align="center">
   <a href="https://github.com/kwhitley/itty-router" target="_blank">
-    <img src="https://img.shields.io/github/stars/kwhitley/itty-router?style=social" alt="repo stars" />
+    <img src="https://img.shields.io/github/stars/kwhitley/itty-router?style=social" alt="Repo stars" />
   </a>
   <a href="https://www.twitter.com/ittydev" target="_blank">
-    <img src="https://img.shields.io/twitter/follow/ittydev.svg?style=social&label=Follow" alt="follow ittydev" />
+    <img src="https://img.shields.io/twitter/follow/ittydev.svg?style=social&label=Follow" alt="Follow ittydev" />
   </a>
-  <a href="" target="_blank">
-    <img src="" alt="" />
-  </a>
 </p>
@@ -44,0 +41,0 @@

Router.d.ts

 import { IRequest, RouterOptions, RouterType } from './types';
-export declare const Router: <RequestType = IRequest, Args extends any[] = any[], ResponseType = any>({ base, routes, ...other }?: RouterOptions) => RouterType<RequestType, Args, ResponseType>;
+export declare const Router: <RequestType = IRequest, Args extends any[] = any[], ResponseType = any>({ base, routes, ...other }?: RouterOptions<RequestType, Args, ResponseType>) => RouterType<RequestType, Args, ResponseType>;

types/AutoRouterOptions.d.ts

 import { RequestHandler } from './RequestHandler';
 import { ResponseHandler } from './ResponseHandler';
 import { RouterOptions } from './RouterOptions';
-export type AutoRouterOptions = {
-    missing?: RequestHandler;
+export type AutoRouterOptions<RequestType, Args extends any[], ResponseType> = {
+    missing?: RequestHandler<RequestType, Args>;
     format?: ResponseHandler;
-} & RouterOptions;
+} & RouterOptions<RequestType, Args, ResponseType>;

types/AutoRouterType.d.ts

@@ -5,5 +5,5 @@ import { IRequest } from './IRequest';
 import { RouterType } from './RouterType';
-export type AutoRouterType<R = IRequest, Args extends any[] = any[], ResponseType = any> = {
-    missing?: RequestHandler;
+export type AutoRouterType<RequestType = IRequest, Args extends any[] = any[], ResponseType = any> = {
+    missing?: RequestHandler<RequestType, Args>;
     format?: ResponseHandler;
-} & RouterType<R, Args, ResponseType>;
+} & RouterType<RequestType, Args, ResponseType>;

types/IttyRouterType.d.ts

@@ -7,14 +7,14 @@ import { GenericTraps } from './GenericTraps';
 import { CustomRoutes } from './CustomRoutes';
-export type IttyRouterType<R = IRequest, A extends any[] = any[], ResponseType = any, GlobalRequestType = R> = {
-    __proto__: IttyRouterType<R>;
+export type IttyRouterType<RequestType = IRequest, Args extends any[] = any[], ResponseType = any> = {
+    __proto__: IttyRouterType<RequestType, Args, ResponseType>;
     routes: RouteEntry[];
-    fetch: <Args extends any[] = A>(request: RequestLike, ...extra: Args) => Promise<ResponseType>;
-    all: Route<GlobalRequestType, A>;
-    delete: Route<GlobalRequestType, A>;
-    get: Route<GlobalRequestType, A>;
-    head: Route<GlobalRequestType, A>;
-    options: Route<GlobalRequestType, A>;
-    patch: Route<GlobalRequestType, A>;
-    post: Route<GlobalRequestType, A>;
-    put: Route<GlobalRequestType, A>;
-} & CustomRoutes<Route<GlobalRequestType, A>> & GenericTraps;
+    fetch: <A extends any[] = Args>(request: RequestLike, ...extra: A) => Promise<ResponseType>;
+    all: Route<RequestType, Args>;
+    delete: Route<RequestType, Args>;
+    get: Route<RequestType, Args>;
+    head: Route<RequestType, Args>;
+    options: Route<RequestType, Args>;
+    patch: Route<RequestType, Args>;
+    post: Route<RequestType, Args>;
+    put: Route<RequestType, Args>;
+} & CustomRoutes<Route<RequestType, Args>> & GenericTraps;

types/RequestHandler.d.ts

 import { IRequest } from './IRequest';
-export type RequestHandler<R = IRequest, Args extends Array<any> = any[]> = (request: R, ...args: Args) => any;
+export type RequestHandler<RequestType = IRequest, Args extends Array<any> = any[]> = (request: RequestType, ...args: Args) => any;

types/ResponseHandler.d.ts

 import { IRequest } from './IRequest';
-export type ResponseHandler<ResponseType = Response, RequestType = IRequest, Args extends any[] = any[]> = (response: ResponseType & any, request: RequestType & any, ...args: Args) => any;
+export type ResponseHandler<ResponseType = any, RequestType = IRequest, Args extends any[] = any[]> = (response: ResponseType, request: RequestType, ...args: Args) => any;

types/RouteEntry.d.ts

@@ -0,7 +1,8 @@
+import { IRequest } from './IRequest';
 import { RequestHandler } from './RequestHandler';
-export type RouteEntry = [
+export type RouteEntry<RequestType = IRequest, Args extends any[] = any[]> = [
     httpMethod: string,
     match: RegExp,
-    handlers: RequestHandler[],
+    handlers: RequestHandler<RequestType, Args>[],
     path?: string
 ];

types/RouterOptions.d.ts

@@ -0,9 +1,11 @@
+import { StatusError } from 'StatusError';
 import { ErrorHandler } from './ErrorHandler';
+import { IRequest } from './IRequest';
 import { IttyRouterOptions } from './IttyRouterOptions';
 import { RequestHandler } from './RequestHandler';
 import { ResponseHandler } from './ResponseHandler';
-export type RouterOptions = {
-    before?: RequestHandler<any>[];
-    catch?: ErrorHandler;
-    finally?: ResponseHandler[];
+export type RouterOptions<RequestType = IRequest, Args extends any[] = [], ResponseType = any> = {
+    before?: RequestHandler<RequestType, Args>[];
+    catch?: ErrorHandler<StatusError, RequestType, Args>;
+    finally?: ResponseHandler<any, RequestType, Args>[];
 } & IttyRouterOptions;

types/RouterType.d.ts

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

No alert changes

Improved metrics

Total package byte prevSize

84352

increased by0.65%

Lines of code

351

increased by1.15%

Worsened metrics

Number of lines in readme file

88

decreased by-3.3%

No dependency changes