wok-server 0.4.13 → 0.6.0

package/types/log/index.d.ts

@@ -1,34 +1,53 @@
-/**
- * 获取日志对象.
- * @returns
- */
-export declare function getLogger(): Readonly<{
-    /**
-     * 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;
-    isWarnEnabled(): boolean;
-    /**
-     * 错误日志
-     * @param message
-     * @param error
-     */
-    error(message: string, error?: any): void;
-    isErrorEnabled(): boolean;
-}>;
-export * from './config';
-export * from './level';
-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

@@ -0,0 +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;

package/types/log/store.d.ts

@@ -1,12 +1,19 @@
-/**
- * 日志存储函数
- */
-export interface LogStore {
-    (log: string): 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);
+}

package/types/mongodb/index.d.ts

@@ -1,29 +1,29 @@
-import { MongoDBManager } from './manager';
-import { MongoMigrationVersion } from './migration';
-/**
- * 启用 MongoDB
- * @param opts 选项
- */
-export declare function enableMongoDB(opts?: {
-    /**
-     * 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
-     */
-    name?: string;
-    /**
-     * 迁移
-     */
-    migration?: {
-        versionList: MongoMigrationVersion[];
-    };
-}): Promise<void>;
-/**
- * 获取管理器实例
- * @param name
- * @returns
- */
-export declare function getMongoDBManager(name?: string): MongoDBManager;
-export { MongoDBConfig } from './config';
-export * from './exception';
-export { MongoMigrationVersion } from './migration';
-export * from './collection';
-export * from './doc';
+import { MongoDBManager } from './manager';
+import { MongoMigrationVersion } from './migration';
+/**
+ * 启用 MongoDB
+ * @param opts 选项
+ */
+export declare function enableMongoDB(opts?: {
+    /**
+     * 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
+     */
+    name?: string;
+    /**
+     * 迁移
+     */
+    migration?: {
+        versionList: MongoMigrationVersion[];
+    };
+}): Promise<void>;
+/**
+ * 获取管理器实例
+ * @param name
+ * @returns
+ */
+export declare function getMongoDBManager(name?: string): MongoDBManager;
+export { MongoDBConfig } from './config';
+export * from './exception';
+export { MongoMigrationVersion } from './migration';
+export * from './collection';
+export * from './doc';