@kevisual/router 0.2.3 → 0.2.4

package/dist/router-simple.d.ts

@@ -0,0 +1,109 @@
+import { Key } from 'path-to-regexp';
+import { IncomingMessage, ServerResponse, Server } from 'node:http';
+import { ListenOptions } from 'node:net';
+
+type Req = IncomingMessage & {
+    params?: Record<string, string>;
+};
+type SimpleObject = {
+    [key: string]: any;
+};
+interface Route {
+    method: string;
+    regexp: RegExp;
+    keys: Key[];
+    handlers: Array<(req: Req, res: ServerResponse) => Promise<void> | void>;
+}
+/**
+ * SimpleRouter
+ */
+declare class SimpleRouter {
+    routes: Route[];
+    exclude: string[];
+    constructor(opts?: {
+        exclude?: string[];
+    });
+    getBody(req: Req): Promise<Record<string, any>>;
+    getSearch(req: Req): any;
+    parseSearchValue: (value?: string, opts?: {
+        decode?: boolean;
+    }) => any;
+    use(method: string, route: string, ...fns: Array<(req: Req, res: ServerResponse) => Promise<void> | void>): this;
+    get(route: string, ...fns: Array<(req: Req, res: ServerResponse) => Promise<void> | void>): this;
+    post(route: string, ...fns: Array<(req: Req, res: ServerResponse) => Promise<void> | void>): this;
+    sse(route: string, ...fns: Array<(req: Req, res: ServerResponse) => Promise<void> | void>): this;
+    all(route: string, ...fns: Array<(req: Req, res: ServerResponse) => Promise<void> | void>): this;
+    getJson(v: string | number | boolean | SimpleObject): any;
+    isSse(req: Req): boolean;
+    /**
+     * 解析 req 和 res 请求
+     * @param req
+     * @param res
+     * @returns
+     */
+    parse(req: Req, res: ServerResponse): Promise<void> | "is_exclude" | "not_found";
+    /**
+     * 创建一个新的 HttpChain 实例
+     * @param req
+     * @param res
+     * @returns
+     */
+    chain(req?: Req, res?: ServerResponse): HttpChain;
+    static Chain(opts?: HttpChainOpts): HttpChain;
+}
+type HttpChainOpts = {
+    req?: Req;
+    res?: ServerResponse;
+    simpleRouter?: SimpleRouter;
+    server?: Server;
+};
+/**
+ * HttpChain 类, 用于链式调用,router.get内部使用
+ */
+declare class HttpChain {
+    /**
+     * 请求对象, 每一次请求都是不一样的
+     */
+    req: Req;
+    /**
+     * 响应对象, 每一次请求响应都是不一样的
+     */
+    res: ServerResponse;
+    simpleRouter: SimpleRouter;
+    server: Server;
+    hasSetHeader: boolean;
+    isSseSet: boolean;
+    constructor(opts?: HttpChainOpts);
+    setReq(req: Req): this;
+    setRes(res: ServerResponse): this;
+    setRouter(router: SimpleRouter): this;
+    setServer(server: Server): this;
+    /**
+     * 兼容 express 的一点功能
+     * @param status
+     * @returns
+     */
+    status(status: number): this;
+    writeHead(status: number): this;
+    json(data: SimpleObject): this;
+    /**
+     * 兼容 express 的一点功能
+     * @param data
+     * @returns
+     */
+    end(data: SimpleObject | string): this;
+    listen(opts: ListenOptions, callback?: () => void): this;
+    /**
+     * 外部 parse 方法
+     * @returns
+     */
+    parse(opts?: {
+        listenOptions?: ListenOptions;
+        listenCallBack?: () => void;
+    }): () => void;
+    getString(value: string | SimpleObject): string;
+    sse(value: string | SimpleObject): this | undefined;
+    close(): this;
+}
+
+export { HttpChain, SimpleRouter };