@tinyhttp/app 2.0.29 → 2.0.32

package/dist/app.d.ts

@@ -7,7 +7,7 @@ import { Middleware, Handler, NextFunction, Router, UseMethodParams } from '@tin
 /**
  * tinyhttp App has a few settings for toggling features
  */
-export declare type AppSettings = Partial<{
+export type AppSettings = Partial<{
     networkExtensions: boolean;
     subdomainOffset: number;
     bindAppToReqRes: boolean;
@@ -18,8 +18,8 @@ export declare type AppSettings = Partial<{
 /**
  * Function that processes the template
  */
-export declare type TemplateFunc<O> = (path: string, locals: Record<string, any>, opts: TemplateEngineOptions<O>, cb: (err: Error, html: unknown) => void) => void;
-export declare type TemplateEngineOptions<O> = Partial<{
+export type TemplateFunc<O> = (path: string, locals: Record<string, any>, opts: TemplateEngineOptions<O>, cb: (err: Error | null, html: unknown) => void) => void;
+export type TemplateEngineOptions<O> = Partial<{
     cache: boolean;
     ext: string;
     renderOptions: Partial<O>;
@@ -50,7 +50,7 @@ export declare type TemplateEngineOptions<O> = Partial<{
  */
 export declare class App<RenderOptions = any, Req extends Request = Request, Res extends Response<RenderOptions> = Response<RenderOptions>> extends Router<App, Req, Res> {
     middleware: Middleware<Req, Res>[];
-    locals: Record<string, string>;
+    locals: Record<string, unknown>;
     noMatchHandler: Handler;
     onError: ErrorHandler;
     settings: AppSettings;

package/dist/index.d.ts

@@ -8,7 +8,7 @@ export { extendMiddleware } from './extend.js';
 export { onErrorHandler } from './onError.js';
 export type { ErrorHandler } from './onError.js';
 import type { NextFunction, Handler as RHandler, AsyncHandler as RAsyncHandler, SyncHandler as RSyncHandler, Middleware } from '@tinyhttp/router';
-export declare type Handler = RHandler<Request, Response>;
-export declare type AsyncHandler = RAsyncHandler<Request, Response>;
-export declare type SyncHandler = RSyncHandler<Request, Response>;
+export type Handler = RHandler<Request, Response>;
+export type AsyncHandler = RAsyncHandler<Request, Response>;
+export type SyncHandler = RSyncHandler<Request, Response>;
 export type { NextFunction, Middleware, Request, Response };

package/dist/index.js

@@ -132,34 +132,49 @@ const applyHandler = (h) => async (req, res, next) => {
   }
 };
 class App extends Router {
-  middleware = [];
-  locals = {};
-  noMatchHandler;
-  onError;
-  settings;
-  engines = {};
-  applyExtensions;
-  attach;
   constructor(options = {}) {
     super();
+    this.middleware = [];
+    this.locals = {};
+    this.engines = {};
     this.onError = (options == null ? void 0 : options.onError) || onErrorHandler;
     this.noMatchHandler = (options == null ? void 0 : options.noMatchHandler) || this.onError.bind(this, { code: 404 });
-    this.settings = options.settings || { xPoweredBy: true, views: process.cwd() };
+    this.settings = options.settings || { xPoweredBy: true, views: `${process.cwd()}/views` };
     this.applyExtensions = options == null ? void 0 : options.applyExtensions;
     this.attach = (req, res) => setImmediate(this.handler.bind(this, req, res, void 0), req, res);
   }
+  /**
+   * Set app setting
+   * @param setting setting name
+   * @param value setting value
+   */
   set(setting, value) {
     this.settings[setting] = value;
     return this;
   }
+  /**
+   * Enable app setting
+   * @param setting Setting name
+   */
   enable(setting) {
     this.settings[setting] = true;
     return this;
   }
+  /**
+   * Disable app setting
+   * @param setting
+   */
   disable(setting) {
     this.settings[setting] = false;
     return this;
   }
+  /**
+   * Render a template
+   * @param file What to render
+   * @param data data that is passed to a template
+   * @param options Template engine options
+   * @param cb Callback that consumes error and html
+   */
   render(file, data = {}, cb, options = {}) {
     options.viewsFolder = options.viewsFolder || this.settings.views || `${process.cwd()}/views`;
     options.ext = options.ext || file.slice(file.lastIndexOf(".") + 1) || "ejs";
@@ -217,6 +232,9 @@ class App extends Router {
     });
     return this;
   }
+  /**
+   * Register a template engine with extension
+   */
   engine(ext, fn) {
     this.engines[ext] = fn;
     return this;
@@ -234,6 +252,11 @@ class App extends Router {
       return m.regex.pattern.test(url) && (m.type === "mw" && fullPathRegex ? fullPathRegex.pattern.test(url) : true);
     });
   }
+  /**
+   * Extends Req / Res objects, pushes 404 and 500 handlers, dispatches middleware
+   * @param req Req object
+   * @param res Res object
+   */
   handler(req, res, next) {
     const { xPoweredBy } = this.settings;
     if (xPoweredBy)
@@ -291,6 +314,12 @@ class App extends Router {
     next = next || ((err) => err ? this.onError(err, req, res) : loop());
     loop();
   }
+  /**
+   * Creates HTTP server and dispatches middleware
+   * @param port server listening port
+   * @param Server callback after server starts listening
+   * @param host server listening host
+   */
   listen(port, cb, host = "0.0.0.0") {
     return createServer().on("request", this.attach).listen(port, host, cb);
   }

package/dist/onError.d.ts

@@ -2,5 +2,5 @@ import type { NextFunction } from '@tinyhttp/router';
 import type { Request } from './request.js';
 import type { Response } from './response.js';
 import type { App } from './app.js';
-export declare type ErrorHandler = (this: App, err: any, req: Request, res: Response, next?: NextFunction) => void;
+export type ErrorHandler = (this: App, err: any, req: Request, res: Response, next?: NextFunction) => void;
 export declare const onErrorHandler: ErrorHandler;

package/dist/request.d.ts

@@ -18,12 +18,12 @@ export declare const getHostname: (req: Request) => string | undefined;
 export declare const getIP: (req: Pick<Request, 'headers' | 'connection' | 'socket'>) => string | undefined;
 export declare const getIPs: (req: Pick<Request, 'headers' | 'connection' | 'socket'>) => string[] | undefined;
 export declare const getSubdomains: (req: Request, subdomainOffset?: number) => string[];
-export declare type Connection = IncomingMessage['socket'] & {
+export type Connection = IncomingMessage['socket'] & {
     encrypted: boolean;
 };
-export declare type Protocol = 'http' | 'https' | string;
+export type Protocol = 'http' | 'https' | string;
 export type { URLParams };
-declare type AcceptsReturns = string | boolean | string[];
+type AcceptsReturns = string | boolean | string[];
 export interface Request extends IncomingMessage {
     originalUrl: string;
     path: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinyhttp/app",
-  "version": "2.0.29",
+  "version": "2.0.32",
   "description": "0-legacy, tiny & fast web framework as a replacement of Express",
   "type": "module",
   "homepage": "https://tinyhttp.v1rtl.site",
@@ -32,13 +32,13 @@
   "author": "v1rtl",
   "license": "MIT",
   "dependencies": {
-    "@tinyhttp/cookie": "2.0.6",
-    "@tinyhttp/proxy-addr": "2.0.6",
-    "@tinyhttp/req": "2.0.16",
-    "@tinyhttp/res": "2.0.22",
-    "@tinyhttp/router": "2.0.7",
     "header-range-parser": "1.1.3",
-    "regexparam": "^2.0.1"
+    "regexparam": "^2.0.1",
+    "@tinyhttp/res": "2.0.23",
+    "@tinyhttp/req": "2.0.16",
+    "@tinyhttp/router": "2.1.0",
+    "@tinyhttp/proxy-addr": "2.0.7",
+    "@tinyhttp/cookie": "2.0.6"
   },
   "scripts": {
     "dev": "vite",