wok-server 0.5.0 → 0.7.0

package/types/mvc/static/static-handler.d.ts

@@ -1,77 +1,77 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-/**
- * 静态资源的映射规则
- */
-export type ServerStaticRules = Record<
-/**
- * 要映射的路径
- */
-string, {
-    /**
-     * 文件目录
-     */
-    dir: string;
-    /**
-     * 客户端缓存时长，单位秒，根据设定生成消息头 Cache-Control: max-age=时长，设置为小于等于0可关闭
-     */
-    cacheAge?: number;
-}>;
-export declare class StaticHandler {
-    private readonly DEFAULT_CONTENT_TYPE;
-    private readonly maxFileSize;
-    private cache?;
-    private rules;
-    /**
-     * 静态处理器。规则说明：
-     * 请求路径仅支持前缀匹配，不支持通配符，比如 /a/demo.html 可以匹配 /a 路径，响应配置的文件目录下的 demo.html 文件。
-     * 路径配置是有优先级的，如果访问 /a/b/music.mp3 则会匹配到 /a/b 的配置，而不是 /a ，因为 /a/b 的配置更详细，优先级也更高，
-     * 并且如果从 /a/b 配置的目录下没有找到文件，也不会再尝试 /a 的配置。
-     *
-     * 静态文件同时也支持主页自动映射，比如访问 /a/b/c ，会匹配到 /a/b 的配置，然后在配置的文件目录下寻找文件 c ，
-     * 如果找不到则尝试寻找目录 c 下的 index.html 文件。
-     * @param rules 规则设置
-     */
-    constructor(rules: ServerStaticRules);
-    /**
-     * 处理静态文件 get 请求
-     * @param request
-     * @param response
-     * @param path
-     * @returns 是否能够处理，如果因为找不到文件或其它原因无法处理则返回 false ，由后续流程继续处理
-     */
-    handleGet(request: IncomingMessage, response: ServerResponse, path: string): Promise<boolean>;
-    /**
-     *  处理 head 请求，不响应正文内容，如果文件可以被找到，仅仅响应以下的消息头：
-     * Content-Length
-     * Content-Type
-     * Last-Modified
-     * Cache-Control
-     *
-     * @param path 请求路径
-     * @param response
-     * @returns 是否成功处理
-     */
-    handleHead(path: string, response: ServerResponse): Promise<boolean>;
-    endRespWithBuffer(response: ServerResponse, buffer: Buffer): Promise<void>;
-    /**
-     * 构建响应文件
-     *
-     * @param path
-     * @param headers
-     * @returns
-     */
-    private buildRespFile;
-    /**
-     * 根据路径查找文件
-     * @param path 访问路径
-     * @returns 返回被查询到的文件信息，如果找不到则返回 null
-     */
-    private findFile;
-    /**
-     * 删除服务器端静态资源缓存
-     * @param path
-     */
-    removeServerCache(path: string): void;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+/**
+ * 静态资源的映射规则
+ */
+export type ServerStaticRules = Record<
+/**
+ * 要映射的路径
+ */
+string, {
+    /**
+     * 文件目录
+     */
+    dir: string;
+    /**
+     * 客户端缓存时长，单位秒，根据设定生成消息头 Cache-Control: max-age=时长，设置为小于等于0可关闭
+     */
+    cacheAge?: number;
+}>;
+export declare class StaticHandler {
+    private readonly DEFAULT_CONTENT_TYPE;
+    private readonly maxFileSize;
+    private cache?;
+    private rules;
+    /**
+     * 静态处理器。规则说明：
+     * 请求路径仅支持前缀匹配，不支持通配符，比如 /a/demo.html 可以匹配 /a 路径，响应配置的文件目录下的 demo.html 文件。
+     * 路径配置是有优先级的，如果访问 /a/b/music.mp3 则会匹配到 /a/b 的配置，而不是 /a ，因为 /a/b 的配置更详细，优先级也更高，
+     * 并且如果从 /a/b 配置的目录下没有找到文件，也不会再尝试 /a 的配置。
+     *
+     * 静态文件同时也支持主页自动映射，比如访问 /a/b/c ，会匹配到 /a/b 的配置，然后在配置的文件目录下寻找文件 c ，
+     * 如果找不到则尝试寻找目录 c 下的 index.html 文件。
+     * @param rules 规则设置
+     */
+    constructor(rules: ServerStaticRules);
+    /**
+     * 处理静态文件 get 请求
+     * @param request
+     * @param response
+     * @param path
+     * @returns 是否能够处理，如果因为找不到文件或其它原因无法处理则返回 false ，由后续流程继续处理
+     */
+    handleGet(request: IncomingMessage, response: ServerResponse, path: string): Promise<boolean>;
+    /**
+     *  处理 head 请求，不响应正文内容，如果文件可以被找到，仅仅响应以下的消息头：
+     * Content-Length
+     * Content-Type
+     * Last-Modified
+     * Cache-Control
+     *
+     * @param path 请求路径
+     * @param response
+     * @returns 是否成功处理
+     */
+    handleHead(path: string, response: ServerResponse): Promise<boolean>;
+    endRespWithBuffer(response: ServerResponse, buffer: Buffer): Promise<void>;
+    /**
+     * 构建响应文件
+     *
+     * @param path
+     * @param headers
+     * @returns
+     */
+    private buildRespFile;
+    /**
+     * 根据路径查找文件
+     * @param path 访问路径
+     * @returns 返回被查询到的文件信息，如果找不到则返回 null
+     */
+    private findFile;
+    /**
+     * 删除服务器端静态资源缓存
+     * @param path
+     */
+    removeServerCache(path: string): void;
+}

package/types/mysql/config.d.ts

@@ -1,90 +1,90 @@
-import { ValidationOpts } from '../validation';
-/**
- * mysql 配置.
- */
-export interface MysqlConfig {
-    /**
-     * 主机名.
-     */
-    host: string;
-    /**
-     * 端口号
-     */
-    port: number;
-    /**
-     * 用户名
-     */
-    user: string;
-    /**
-     * 密码
-     */
-    password: string;
-    /**
-     * 字符集，默认 utf8mb4
-     */
-    charset: string;
-    /**
-     * 库
-     */
-    database: string;
-    /**
-     * 版本控制开启.
-     */
-    versionControlEnabled: boolean;
-    /**
-     * 版本控制的文件目录，默认 db_migration.
-     */
-    versionControlDir: string;
-    /**
-     * 时区，默认 +08:00
-     */
-    timezone: string;
-    /**
-     * 超时时间，单位毫秒，默认 10秒
-     */
-    connectTimeout: number;
-    /**
-     * 调试模式
-     */
-    debug: boolean;
-    /**
-     * 最大连接数
-     */
-    connectionLimit: number;
-    /**
-     * 最大闲置数
-     */
-    maxIdle: number;
-    /**
-     * 闲置的超时时间，也即多久不用算闲置，单位毫秒
-     */
-    idleTimeout: number;
-    /**
-     * 慢 sql 警告，启用后如果一个查询过慢，就会输出警告日志。
-     */
-    slowSqlWarn: boolean;
-    /**
-     * 慢 sql 毫秒数，执行时间超过设定值的 sql 会被认为是慢 sql ，默认 200
-     */
-    slowSqlMs: number;
-    /**
-     * 事务超时时间，单位毫秒，默认 5000，设置为小于等于 0 的值表示不限制
-     */
-    transactionTimeout: number;
-    /**
-     * 事务严格模式
-     */
-    transactionStrict: boolean;
-    /**
-     * 在严格事务中可进行的最大操作次数
-     */
-    maxOpsInStrictTx: number;
-}
-/**
- * 默认配置.
- */
-export declare const defaultConfig: MysqlConfig;
-/**
- * 配置校验规则.
- */
-export declare const configValidation: ValidationOpts<MysqlConfig>;
+import { ValidationOpts } from '../validation';
+/**
+ * mysql 配置.
+ */
+export interface MysqlConfig {
+    /**
+     * 主机名.
+     */
+    host: string;
+    /**
+     * 端口号
+     */
+    port: number;
+    /**
+     * 用户名
+     */
+    user: string;
+    /**
+     * 密码
+     */
+    password: string;
+    /**
+     * 字符集，默认 utf8mb4
+     */
+    charset: string;
+    /**
+     * 库
+     */
+    database: string;
+    /**
+     * 版本控制开启.
+     */
+    versionControlEnabled: boolean;
+    /**
+     * 版本控制的文件目录，默认 db_migration.
+     */
+    versionControlDir: string;
+    /**
+     * 时区，默认 +08:00
+     */
+    timezone: string;
+    /**
+     * 超时时间，单位毫秒，默认 10秒
+     */
+    connectTimeout: number;
+    /**
+     * 调试模式
+     */
+    debug: boolean;
+    /**
+     * 最大连接数
+     */
+    connectionLimit: number;
+    /**
+     * 最大闲置数
+     */
+    maxIdle: number;
+    /**
+     * 闲置的超时时间，当一个数据库连接不再被业务使用、处于闲置状态的时间超过这个阈值，连接池就会自动回收并关闭这个连接，释放资源。
+     */
+    idleTimeout: number;
+    /**
+     * 慢 sql 警告，启用后如果一个查询过慢，就会输出警告日志。
+     */
+    slowSqlWarn: boolean;
+    /**
+     * 慢 sql 毫秒数，执行时间超过设定值的 sql 会被认为是慢 sql ，默认 200
+     */
+    slowSqlMs: number;
+    /**
+     * 事务超时时间，单位毫秒，默认 5000，设置为小于等于 0 的值表示不限制
+     */
+    transactionTimeout: number;
+    /**
+     * 事务严格模式
+     */
+    transactionStrict: boolean;
+    /**
+     * 在严格事务中可进行的最大操作次数
+     */
+    maxOpsInStrictTx: number;
+}
+/**
+ * 默认配置.
+ */
+export declare const defaultConfig: MysqlConfig;
+/**
+ * 配置校验规则.
+ */
+export declare const configValidation: ValidationOpts<MysqlConfig>;

package/types/mysql/exception.d.ts

@@ -1,7 +1,7 @@
-/**
- * mysql 异常.
- */
-export declare class MysqlException extends Error {
-    readonly message: string;
-    constructor(message: string);
-}
+/**
+ * mysql 异常.
+ */
+export declare class MysqlException extends Error {
+    readonly message: string;
+    constructor(message: string);
+}

package/types/mysql/index.d.ts

@@ -1,16 +1,16 @@
-import { MysqlException } from './exception';
-import { MysqlManager } from './manager';
-import { MysqlCriteria } from './manager/ops/criteria';
-import { Table } from './table-info';
-/**
- * 启用mysql
- * @param name 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
- */
-export declare function enableMysql(name?: string): Promise<void>;
-/**
- * 获取管理器.
- * @param name  配置名称，如果调用 enableMysql 时填写了，那么这里也要填写并保持一致
- */
-export declare function getMysqlManager(name?: string): MysqlManager;
-export * from './manager';
-export { MysqlCriteria, MysqlException, Table };
+import { MysqlException } from './exception';
+import { MysqlManager } from './manager';
+import { MysqlCriteria } from './manager/ops/criteria';
+import { Table } from './table-info';
+/**
+ * 启用mysql
+ * @param name 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
+ */
+export declare function enableMysql(name?: string): Promise<void>;
+/**
+ * 获取管理器.
+ * @param name  配置名称，如果调用 enableMysql 时填写了，那么这里也要填写并保持一致
+ */
+export declare function getMysqlManager(name?: string): MysqlManager;
+export * from './manager';
+export { MysqlCriteria, MysqlException, Table };