wok-server 0.5.0 → 0.7.0

package/types/lock/index.d.ts

@@ -1,64 +1,64 @@
-export interface LockInfo {
-    /**
-     * 一个随机值，用于验证锁是否为当前程序所拥有
-     */
-    value: string;
-    /**
-     * 锁过期的时间
-     */
-    expiresAt: number;
-}
-/**
- * 锁管理器，主要用于将不确定的顺序且有冲突的异步操作顺序执行，
- * 防止异步流程庞大穿插执行造成的数据混乱和错误，常见于请求的处理。
- */
-declare class ServerLockManager {
-    /**
-     * 存储锁信息的表，值是一个随机值，用于验证锁是否为当前程序所拥有
-     */
-    private lockMap;
-    constructor();
-    /**
-     * 尝试竞争锁，如果成功获取到锁，则执行 run 函数
-     * @param opts
-     * @returns 是否获取到锁
-     */
-    tryLock(opts: {
-        /**
-         * 竞争锁的标识，相同的 key 会处于竞争关系，从而按顺序执行
-         */
-        key: string;
-        /**
-         * 等待秒数，如果没有获取锁，要等待的时间，单位秒。
-         * 不设置的情况下则不会等待，获取不到锁就立即返回。
-         */
-        waitSeconds?: number;
-        /**
-         * 运行函数，成功获取锁就会执行
-         * @returns
-         */
-        run: () => Promise<void>;
-        /**
-         * 过期时间，单位秒。目的是防止一个程序长期占用锁，导致其它程序获取不到锁一直不能被执行
-         * 导致的死锁问题。锁一旦过期，当前程序就不再拥有锁，其它程序就可以获取到锁。默认 60 秒。
-         */
-        expiresInSeconds?: number;
-    }): Promise<boolean>;
-    /**
-     * 等待锁
-     * @param opts
-     */
-    private waitLock;
-    /**
-     * 沉睡
-     * @returns
-     */
-    private sleep;
-}
-/**
- * 获取锁管理器。锁管理器提供一个简单的异步并发控制，用于将不确定的顺序的有冲突的异步操作顺序执行，
- * 防止异步流程庞大穿插执行造成的数据混乱和错误，常见于请求的处理。
- * @returns
- */
-export declare function getLockManager(): ServerLockManager;
-export {};
+export interface LockInfo {
+    /**
+     * 一个随机值，用于验证锁是否为当前程序所拥有
+     */
+    value: string;
+    /**
+     * 锁过期的时间
+     */
+    expiresAt: number;
+}
+/**
+ * 锁管理器，主要用于将不确定的顺序且有冲突的异步操作顺序执行，
+ * 防止异步流程庞大穿插执行造成的数据混乱和错误，常见于请求的处理。
+ */
+declare class ServerLockManager {
+    /**
+     * 存储锁信息的表，值是一个随机值，用于验证锁是否为当前程序所拥有
+     */
+    private lockMap;
+    constructor();
+    /**
+     * 尝试竞争锁，如果成功获取到锁，则执行 run 函数
+     * @param opts
+     * @returns 是否获取到锁
+     */
+    tryLock(opts: {
+        /**
+         * 竞争锁的标识，相同的 key 会处于竞争关系，从而按顺序执行
+         */
+        key: string;
+        /**
+         * 等待秒数，如果没有获取锁，要等待的时间，单位秒。
+         * 不设置的情况下则不会等待，获取不到锁就立即返回。
+         */
+        waitSeconds?: number;
+        /**
+         * 运行函数，成功获取锁就会执行
+         * @returns
+         */
+        run: () => Promise<void>;
+        /**
+         * 过期时间，单位秒。目的是防止一个程序长期占用锁，导致其它程序获取不到锁一直不能被执行
+         * 导致的死锁问题。锁一旦过期，当前程序就不再拥有锁，其它程序就可以获取到锁。默认 60 秒。
+         */
+        expiresInSeconds?: number;
+    }): Promise<boolean>;
+    /**
+     * 等待锁
+     * @param opts
+     */
+    private waitLock;
+    /**
+     * 沉睡
+     * @returns
+     */
+    private sleep;
+}
+/**
+ * 获取锁管理器。锁管理器提供一个简单的异步并发控制，用于将不确定的顺序的有冲突的异步操作顺序执行，
+ * 防止异步流程庞大穿插执行造成的数据混乱和错误，常见于请求的处理。
+ * @returns
+ */
+export declare function getLockManager(): ServerLockManager;
+export {};

package/types/log/config.d.ts

@@ -1,35 +1,35 @@
-import { LogLevel } from './level';
-/**
- * 日志配置的定义
- */
-interface EnvConfig {
-    /**
-     * 是否输出日志到控制台
-     */
-    console: boolean;
-    /**
-     * 输出日志的格式
-     */
-    format: 'text' | 'json';
-    /**
-     * 是否输出到文件，如果为 true ，则会在根目录下生成 logs 目录存放日志文件.
-     */
-    file: boolean;
-    /**
-     * 文件目录
-     */
-    fileDir: string;
-    /**
-     * 文件最大保存天数.需要开启文件才有效.
-     */
-    fileMaxDays: number;
-    /**
-     * 要输出的日志级别.
-     */
-    level: string;
-}
-export type LogConfig = Omit<EnvConfig, 'level'> & {
-    level: LogLevel;
-};
-export declare const config: LogConfig;
-export {};
+import { LogLevel } from './level';
+/**
+ * 日志配置的定义
+ */
+interface EnvConfig {
+    /**
+     * 是否输出日志到控制台
+     */
+    console: boolean;
+    /**
+     * 输出日志的格式
+     */
+    format: 'text' | 'json';
+    /**
+     * 是否输出到文件，如果为 true ，则会在根目录下生成 logs 目录存放日志文件.
+     */
+    file: boolean;
+    /**
+     * 文件目录
+     */
+    fileDir: string;
+    /**
+     * 文件最大保存天数.需要开启文件才有效.
+     */
+    fileMaxDays: number;
+    /**
+     * 要输出的日志级别.
+     */
+    level: string;
+}
+export type LogConfig = Omit<EnvConfig, 'level'> & {
+    level: LogLevel;
+};
+export declare const config: LogConfig;
+export {};

package/types/log/date.d.ts

@@ -1,2 +1,2 @@
-export declare function currentDateTimeStr(): string;
-export declare function formatDateTime(date: Date): string;
+export declare function currentDateTimeStr(): string;
+export declare function formatDateTime(date: Date): string;

package/types/log/file.d.ts

@@ -1,13 +1,13 @@
-import { LogConfig } from './config';
-import { Log } from './log';
-/**
- * 文件存储.
- * @param log 日志对象
- * @param logConfig 日志配置
- */
-export declare function fileStore(log: Log, logConfig: LogConfig): void;
-/**
- * 确保所有日志都被写入文件
- * 可以在应用程序关闭时调用
- */
-export declare function flushLogsToFile(): Promise<void>;
+import { LogConfig } from './config';
+import { Log } from './log';
+/**
+ * 文件存储.
+ * @param log 日志对象
+ * @param logConfig 日志配置
+ */
+export declare function fileStore(log: Log, logConfig: LogConfig): void;
+/**
+ * 确保所有日志都被写入文件
+ * 可以在应用程序关闭时调用
+ */
+export declare function flushLogsToFile(): Promise<void>;

package/types/log/index.d.ts

@@ -1,53 +1,53 @@
-declare class Logger {
-    private prefix?;
-    constructor(prefix?: string | undefined);
-    /**
-     * 输出日志
-     * @param level
-     * @param message
-     * @param error
-     */
-    private log;
-    /**
-     * debug 日志
-     */
-    debug(message: string): void;
-    isDebugEnabled(): boolean;
-    /**
-     * info 日志
-     * @param message
-     */
-    info(message: string): void;
-    isInfoEnabled(): boolean;
-    /**
-     * 警告日志
-     * @param message
-     * @param error
-     */
-    warn(message: string, error?: any): void;
-    /**
-     * 等同于 warn
-     * @param message
-     * @param error
-     */
-    warning(message: string, error?: any): void;
-    isWarnEnabled(): boolean;
-    /**
-     * 错误日志
-     * @param message
-     * @param error
-     */
-    error(message: string, error?: any): void;
-    isErrorEnabled(): boolean;
-}
-/**
- * 获取日志对象.
- *
- * @param prefix 日志前缀，如果有值，每条日志前都会加上前缀信息
- * @returns
- */
-export declare function getLogger(prefix?: string): Logger;
-export * from './config';
-export * from './level';
-export * from './log';
-export { setLogStore } from './store';
+declare class Logger {
+    private prefix?;
+    constructor(prefix?: string | undefined);
+    /**
+     * 输出日志
+     * @param level
+     * @param message
+     * @param error
+     */
+    private log;
+    /**
+     * debug 日志
+     */
+    debug(message: string): void;
+    isDebugEnabled(): boolean;
+    /**
+     * info 日志
+     * @param message
+     */
+    info(message: string): void;
+    isInfoEnabled(): boolean;
+    /**
+     * 警告日志
+     * @param message
+     * @param error
+     */
+    warn(message: string, error?: any): void;
+    /**
+     * 等同于 warn
+     * @param message
+     * @param error
+     */
+    warning(message: string, error?: any): void;
+    isWarnEnabled(): boolean;
+    /**
+     * 错误日志
+     * @param message
+     * @param error
+     */
+    error(message: string, error?: any): void;
+    isErrorEnabled(): boolean;
+}
+/**
+ * 获取日志对象.
+ *
+ * @param prefix 日志前缀，如果有值，每条日志前都会加上前缀信息
+ * @returns
+ */
+export declare function getLogger(prefix?: string): Logger;
+export * from './config';
+export * from './level';
+export * from './log';
+export { setLogStore } from './store';

package/types/log/level.d.ts

@@ -1,14 +1,14 @@
-/**
- * 日志级别.
- */
-export declare enum LogLevel {
-    DEBUG = 1,
-    INFO = 2,
-    WARN = 3,
-    ERROR = 4
-}
-/**
- * 解析日志级别
- * @param level
- */
-export declare function parseLogLevel(level: string): LogLevel;
+/**
+ * 日志级别.
+ */
+export declare enum LogLevel {
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
+}
+/**
+ * 解析日志级别
+ * @param level
+ */
+export declare function parseLogLevel(level: string): LogLevel;

package/types/log/log.d.ts

@@ -1,40 +1,40 @@
-import { LogLevel } from './level';
-/**
- * 单条日志的信息
- */
-export interface Log {
-    /**
-     * 日志的时间
-     */
-    time: Date;
-    /**
-     * 日志的等级
-     */
-    level: LogLevel;
-    /**
-     * 日志的内容
-     */
-    content: string;
-    /**
-     * 异常信息
-     */
-    error?: any;
-    /**
-     * 前缀信息
-     */
-    prefix?: string;
-}
-/**
- * 将日志格式化为简单的文本
- * @param log
- * @param ignoreError 忽略异常信息
- * @returns
- */
-export declare function formatLogText(log: Log, ignoreError?: boolean): string;
-/**
- * 将日志格式化为 json
- * @param log
- * @param ignoreError 忽略异常信息
- * @returns
- */
-export declare function formatLogJson(log: Log, ignoreError?: boolean): string;
+import { LogLevel } from './level';
+/**
+ * 单条日志的信息
+ */
+export interface Log {
+    /**
+     * 日志的时间
+     */
+    time: Date;
+    /**
+     * 日志的等级
+     */
+    level: LogLevel;
+    /**
+     * 日志的内容
+     */
+    content: string;
+    /**
+     * 异常信息
+     */
+    error?: any;
+    /**
+     * 前缀信息
+     */
+    prefix?: string;
+}
+/**
+ * 将日志格式化为简单的文本
+ * @param log
+ * @param ignoreError 忽略异常信息
+ * @returns
+ */
+export declare function formatLogText(log: Log, ignoreError?: boolean): string;
+/**
+ * 将日志格式化为 json
+ * @param log
+ * @param ignoreError 忽略异常信息
+ * @returns
+ */
+export declare function formatLogJson(log: Log, ignoreError?: boolean): string;

package/types/log/store.d.ts

@@ -1,19 +1,19 @@
-import { LogConfig } from './config';
-import { Log } from './log';
-/**
- * 日志存储函数
- */
-export interface LogStore {
-    /**
-     * 日志存储函数
-     * @param log 日志
-     * @param config 日志配置
-     */
-    (log: Log, config: LogConfig): void;
-}
-/**
- * 设置日志存储.
- * @param store
- */
-export declare function setLogStore(store: LogStore): void;
-export declare function getLogStore(): LogStore | undefined;
+import { LogConfig } from './config';
+import { Log } from './log';
+/**
+ * 日志存储函数
+ */
+export interface LogStore {
+    /**
+     * 日志存储函数
+     * @param log 日志
+     * @param config 日志配置
+     */
+    (log: Log, config: LogConfig): void;
+}
+/**
+ * 设置日志存储.
+ * @param store
+ */
+export declare function setLogStore(store: LogStore): void;
+export declare function getLogStore(): LogStore | undefined;

package/types/mongodb/collection.d.ts

@@ -1,25 +1,25 @@
-/**
- * mogodb 集合信息
- *
- * <T> 数据类型，不能包含有 _id 字段，主键字段名称固定，不可以设置
- */
-export interface MongoCollection<T> {
-    /**
-     * 集合名称.
-     */
-    collectionName: string;
-    /**
-     * 创建时间字段信息,设置后在创建时会自动更新该字段
-     */
-    createdDate?: {
-        field: keyof T;
-        type: 'number' | 'date';
-    };
-    /**
-     * 更新时间字段信息，设置后在更新记录时会自动维护该字段
-     */
-    updatedDate?: {
-        field: keyof T;
-        type: 'number' | 'date';
-    };
-}
+/**
+ * mogodb 集合信息
+ *
+ * <T> 数据类型，不能包含有 _id 字段，主键字段名称固定，不可以设置
+ */
+export interface MongoCollection<T> {
+    /**
+     * 集合名称.
+     */
+    collectionName: string;
+    /**
+     * 创建时间字段信息,设置后在创建时会自动更新该字段
+     */
+    createdDate?: {
+        field: keyof T;
+        type: 'number' | 'date';
+    };
+    /**
+     * 更新时间字段信息，设置后在更新记录时会自动维护该字段
+     */
+    updatedDate?: {
+        field: keyof T;
+        type: 'number' | 'date';
+    };
+}

package/types/mongodb/config.d.ts

@@ -1,45 +1,45 @@
-import { ValidationOpts } from '../validation';
-/**
- * MongoDB 配置.
- */
-export interface MongoDBConfig {
-    /**
-     * 连接地址.
-     * 示例：mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority
-     */
-    uri: string;
-    /** The maximum number of connections in the connection pool. */
-    maxPoolSize: number;
-    /** The minimum number of connections in the connection pool. */
-    minPoolSize: number;
-    /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
-    maxConnecting: number;
-    /** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
-    maxIdleTimeMS: number;
-    /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
-    waitQueueTimeoutMS: number;
-    /**
-     * 开启慢查询警告，默认开启
-     */
-    slowQueryWarn: boolean;
-    /**
-     * 慢查询毫秒数，默认 200
-     */
-    slowQueryMs: number;
-    /**
-     *事务超时时间，单位毫秒，默认 5000，设置为0的值表示不限制
-     */
-    transactionTimeout: number;
-    /**
-     * 事务严格模式
-     */
-    transactionStrict: boolean;
-}
-/**
- * 默认配置.
- */
-export declare const defaultConfig: MongoDBConfig;
-/**
- * 配置校验
- */
-export declare const configValidation: ValidationOpts<MongoDBConfig>;
+import { ValidationOpts } from '../validation';
+/**
+ * MongoDB 配置.
+ */
+export interface MongoDBConfig {
+    /**
+     * 连接地址.
+     * 示例：mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&writeConcern=majority
+     */
+    uri: string;
+    /** The maximum number of connections in the connection pool. */
+    maxPoolSize: number;
+    /** The minimum number of connections in the connection pool. */
+    minPoolSize: number;
+    /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
+    maxConnecting: number;
+    /** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
+    maxIdleTimeMS: number;
+    /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
+    waitQueueTimeoutMS: number;
+    /**
+     * 开启慢查询警告，默认开启
+     */
+    slowQueryWarn: boolean;
+    /**
+     * 慢查询毫秒数，默认 200
+     */
+    slowQueryMs: number;
+    /**
+     *事务超时时间，单位毫秒，默认 5000，设置为0的值表示不限制
+     */
+    transactionTimeout: number;
+    /**
+     * 事务严格模式
+     */
+    transactionStrict: boolean;
+}
+/**
+ * 默认配置.
+ */
+export declare const defaultConfig: MongoDBConfig;
+/**
+ * 配置校验
+ */
+export declare const configValidation: ValidationOpts<MongoDBConfig>;

package/types/mongodb/doc.d.ts

@@ -1,11 +1,11 @@
-import { ObjectId } from 'mongodb';
-/**
- * 文档 id
- */
-export type MongoDocId = string | ObjectId;
-/**
- * 带 id 的文档。<T> 是自定义的集合类型，不包含主键字段。
- */
-export type MongoDocWithId<T> = T & {
-    _id: MongoDocId;
-};
+import { ObjectId } from 'mongodb';
+/**
+ * 文档 id
+ */
+export type MongoDocId = string | ObjectId;
+/**
+ * 带 id 的文档。<T> 是自定义的集合类型，不包含主键字段。
+ */
+export type MongoDocWithId<T> = T & {
+    _id: MongoDocId;
+};

package/types/mongodb/exception.d.ts

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