wok-server 0.5.0 → 0.7.0

package/types/task/fixed-rate.d.ts

@@ -1,9 +1,9 @@
-import { Task, TaskController } from './task';
-/**
- * 固定延迟执行任务
- * @param initialDelay  第一次执行延迟的时间，单位秒
- * @param period 每次的延迟时间，单位秒
- * @param task 任务
- * @param timeout 任务超时时间，单位毫秒
- */
-export declare function scheduleWithFixedRate(initialDelay: number, period: number, task: Task, timeout?: number): TaskController;
+import { Task, TaskController } from './task';
+/**
+ * 固定延迟执行任务
+ * @param initialDelay  第一次执行延迟的时间，单位秒
+ * @param period 每次的延迟时间，单位秒
+ * @param task 任务
+ * @param timeout 任务超时时间，单位毫秒
+ */
+export declare function scheduleWithFixedRate(initialDelay: number, period: number, task: Task, timeout?: number): TaskController;

package/types/task/index.d.ts

@@ -1,4 +1,4 @@
-export { Task, TaskController } from './task';
-export * from './fixed-delay';
-export * from './fixed-rate';
-export * from './daily';
+export { Task, TaskController } from './task';
+export * from './fixed-delay';
+export * from './fixed-rate';
+export * from './daily';

package/types/task/task.d.ts

@@ -1,34 +1,34 @@
-/**
- * 任务.
- */
-export interface Task {
-    /**
-     * 任务的名称，用于跟踪任务的执行情况，定位错误.
-     * 当任务执行时间过长或任务失败时，相关的错误提示信息会显示名称，以便于排查.
-     */
-    name: string;
-    /**
-     * 任务运行.
-     * @returns
-     */
-    run: () => Promise<void>;
-}
-/**
- * 任务控制器
- */
-export declare class TaskController {
-    #private;
-    isStopped(): boolean;
-    stop(): void;
-}
-/**
- * 任务执行，封装任务执行过程中的一些通用信息输出和异常控制.
- * @param task
- * @param timeout 任务超时时间，单位毫秒
- * @returns
- */
-export declare function execTask(task: Task, timeout?: number): Promise<{
-    start: number;
-    cost: number;
-    end: number;
-}>;
+/**
+ * 任务.
+ */
+export interface Task {
+    /**
+     * 任务的名称，用于跟踪任务的执行情况，定位错误.
+     * 当任务执行时间过长或任务失败时，相关的错误提示信息会显示名称，以便于排查.
+     */
+    name: string;
+    /**
+     * 任务运行.
+     * @returns
+     */
+    run: () => Promise<void>;
+}
+/**
+ * 任务控制器
+ */
+export declare class TaskController {
+    #private;
+    isStopped(): boolean;
+    stop(): void;
+}
+/**
+ * 任务执行，封装任务执行过程中的一些通用信息输出和异常控制.
+ * @param task
+ * @param timeout 任务超时时间，单位毫秒
+ * @returns
+ */
+export declare function execTask(task: Task, timeout?: number): Promise<{
+    start: number;
+    cost: number;
+    end: number;
+}>;

package/types/validation/exception.d.ts

@@ -1,38 +1,38 @@
-/**
- * 校验异常.
- */
-export declare class ValidationException extends Error {
-    /**
-     * 异常信息，如 “不能为空” 之类的.
-     */
-    readonly errMsg: string;
-    /**
-     * 校验器名称，如 length 、notNull 之类的.
-     */
-    readonly validator: string;
-    /**
-     * 校验出错的路径.
-     */
-    readonly propertyPath: string;
-    /**
-     * 值
-     */
-    readonly val: any;
-    constructor(
-    /**
-     * 异常信息，如 “不能为空” 之类的.
-     */
-    errMsg: string, 
-    /**
-     * 校验器名称，如 length 、notNull 之类的.
-     */
-    validator: string, 
-    /**
-     * 校验出错的路径.
-     */
-    propertyPath: string, 
-    /**
-     * 值
-     */
-    val: any);
-}
+/**
+ * 校验异常.
+ */
+export declare class ValidationException extends Error {
+    /**
+     * 异常信息，如 “不能为空” 之类的.
+     */
+    readonly errMsg: string;
+    /**
+     * 校验器名称，如 length 、notNull 之类的.
+     */
+    readonly validator: string;
+    /**
+     * 校验出错的路径.
+     */
+    readonly propertyPath: string;
+    /**
+     * 值
+     */
+    readonly val: any;
+    constructor(
+    /**
+     * 异常信息，如 “不能为空” 之类的.
+     */
+    errMsg: string, 
+    /**
+     * 校验器名称，如 length 、notNull 之类的.
+     */
+    validator: string, 
+    /**
+     * 校验出错的路径.
+     */
+    propertyPath: string, 
+    /**
+     * 值
+     */
+    val: any);
+}

package/types/validation/index.d.ts

@@ -1,32 +1,32 @@
-/**
- * 校验结果。message：错误信息，反馈给调用处；validator 校验器名称，用于记录错误信息来自哪个校验器，
- * 以便于程序在出错时知道信息来自哪里。
- */
-export type ValidationResult = {
-    ok: true;
-} | {
-    ok: false;
-    message: string;
-    validator: string;
-    /**
-     * 如果校验的是层级深的对象，内部的属性发生了错误，可用于标记属性的路径
-     */
-    propPath?: string[];
-};
-/**
- * 校验器.
- */
-export type PropValidator<T> = (val: T) => ValidationResult;
-/**
- * 对象的校验选项
- */
-export type ValidationOpts<T> = Partial<{
-    [key in keyof T]: PropValidator<T[key]>[];
-}>;
-/**
- * 校验对象.
- * @param obj
- */
-export declare function validate<T>(obj: T, opts: ValidationOpts<T>): void;
-export * from './exception';
-export * from './validator';
+/**
+ * 校验结果。message：错误信息，反馈给调用处；validator 校验器名称，用于记录错误信息来自哪个校验器，
+ * 以便于程序在出错时知道信息来自哪里。
+ */
+export type ValidationResult = {
+    ok: true;
+} | {
+    ok: false;
+    message: string;
+    validator: string;
+    /**
+     * 如果校验的是层级深的对象，内部的属性发生了错误，可用于标记属性的路径
+     */
+    propPath?: string[];
+};
+/**
+ * 校验器.
+ */
+export type PropValidator<T> = (val: T) => ValidationResult;
+/**
+ * 对象的校验选项
+ */
+export type ValidationOpts<T> = Partial<{
+    [key in keyof T]: PropValidator<T[key]>[];
+}>;
+/**
+ * 校验对象.
+ * @param obj
+ */
+export declare function validate<T>(obj: T, opts: ValidationOpts<T>): void;
+export * from './exception';
+export * from './validator';

package/types/validation/validator/array.d.ts

@@ -1,5 +1,5 @@
-import { PropValidator } from '..';
-/**
- * 校验数组的条目.
- */
-export declare function array<T>(opts: PropValidator<T>[]): PropValidator<T[] | undefined>;
+import { PropValidator } from '..';
+/**
+ * 校验数组的条目.
+ */
+export declare function array<T>(opts: PropValidator<T>[]): PropValidator<T[] | undefined>;

package/types/validation/validator/enum.d.ts

@@ -1,8 +1,8 @@
-import { PropValidator } from '..';
-/**
- * 枚举，校验值必须是指定列表中的一个.
- * @param list 支持的值列表，仅支持数字和字符串类型
- * @param msg
- * @returns
- */
-export declare function enumerate<T>(list: (number | string)[], msg?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 枚举，校验值必须是指定列表中的一个.
+ * @param list 支持的值列表，仅支持数字和字符串类型
+ * @param msg
+ * @returns
+ */
+export declare function enumerate<T>(list: (number | string)[], msg?: string): PropValidator<T>;

package/types/validation/validator/index.d.ts

@@ -1,11 +1,11 @@
-export * from './not-null';
-export * from './not-blank';
-export * from './max';
-export * from './min';
-export * from './regexp';
-export * from './length';
-export * from './enum';
-export * from './array';
-export * from './plain-obj';
-export * from './max-length';
-export * from './min-length';
+export * from './not-null';
+export * from './not-blank';
+export * from './max';
+export * from './min';
+export * from './regexp';
+export * from './length';
+export * from './enum';
+export * from './array';
+export * from './plain-obj';
+export * from './max-length';
+export * from './min-length';

package/types/validation/validator/length.d.ts

@@ -1,10 +1,10 @@
-import { PropValidator } from '..';
-/**
- * length 校验，可用于字符串或数组.
- * @returns
- */
-export declare function length<T>(opts: {
-    min?: number;
-    max?: number;
-    message?: string;
-}): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * length 校验，可用于字符串或数组.
+ * @returns
+ */
+export declare function length<T>(opts: {
+    min?: number;
+    max?: number;
+    message?: string;
+}): PropValidator<T>;

package/types/validation/validator/max-length.d.ts

@@ -1,8 +1,8 @@
-import { PropValidator } from '..';
-/**
- * 最大长度校验，可用于字符串或数组.
- * @param maxLength
- * @param message
- * @returns
- */
-export declare function maxLength<T>(maxLength: number, message?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 最大长度校验，可用于字符串或数组.
+ * @param maxLength
+ * @param message
+ * @returns
+ */
+export declare function maxLength<T>(maxLength: number, message?: string): PropValidator<T>;

package/types/validation/validator/max.d.ts

@@ -1,7 +1,7 @@
-import { PropValidator } from '..';
-/**
- * 最大值校验.
- * @param max 最大值
- * @param msg 错误消息
- */
-export declare function max<T>(max: number, msg?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 最大值校验.
+ * @param max 最大值
+ * @param msg 错误消息
+ */
+export declare function max<T>(max: number, msg?: string): PropValidator<T>;

package/types/validation/validator/min-length.d.ts

@@ -1,6 +1,6 @@
-import { PropValidator } from '..';
-/**
- * 最小长度校验，可用于字符串或数组.
- * @returns
- */
-export declare function minLength<T>(minLength: number, message?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 最小长度校验，可用于字符串或数组.
+ * @returns
+ */
+export declare function minLength<T>(minLength: number, message?: string): PropValidator<T>;

package/types/validation/validator/min.d.ts

@@ -1,7 +1,7 @@
-import { PropValidator } from '..';
-/**
- * 最小值校验.
- * @param min 最小值
- * @param msg 错误消息
- */
-export declare function min<T>(min: number, msg?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 最小值校验.
+ * @param min 最小值
+ * @param msg 错误消息
+ */
+export declare function min<T>(min: number, msg?: string): PropValidator<T>;

package/types/validation/validator/not-blank.d.ts

@@ -1,7 +1,7 @@
-import { PropValidator } from '..';
-/**
- * 字符串非空校验，以下的情况不会通过校验：undefined，null，非 string 类型，空白字符串.
- * @param message
- * @returns
- */
-export declare function notBlank<T>(message?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 字符串非空校验，以下的情况不会通过校验：undefined，null，非 string 类型，空白字符串.
+ * @param message
+ * @returns
+ */
+export declare function notBlank<T>(message?: string): PropValidator<T>;

package/types/validation/validator/not-null.d.ts

@@ -1,6 +1,6 @@
-import { PropValidator } from '..';
-/**
- * 非空校验.
- * @param message
- */
-export declare function notNull<T>(message?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 非空校验.
+ * @param message
+ */
+export declare function notNull<T>(message?: string): PropValidator<T>;

package/types/validation/validator/plain-obj.d.ts

@@ -1,7 +1,7 @@
-import { PropValidator, ValidationOpts } from '..';
-/**
- * 普通对象校验.
- * @param opts
- * @returns
- */
-export declare function plainObject<T>(opts: ValidationOpts<Exclude<T, undefined>>): PropValidator<T>;
+import { PropValidator, ValidationOpts } from '..';
+/**
+ * 普通对象校验.
+ * @param opts
+ * @returns
+ */
+export declare function plainObject<T>(opts: ValidationOpts<Exclude<T, undefined>>): PropValidator<T>;

package/types/validation/validator/regexp.d.ts

@@ -1,8 +1,8 @@
-import { PropValidator } from '..';
-/**
- * 正则校验
- * @param pattern 正则表达式
- * @param msg 错误消息
- * @returns
- */
-export declare function regexp<T>(pattern: RegExp, msg?: string): PropValidator<T>;
+import { PropValidator } from '..';
+/**
+ * 正则校验
+ * @param pattern 正则表达式
+ * @param msg 错误消息
+ * @returns
+ */
+export declare function regexp<T>(pattern: RegExp, msg?: string): PropValidator<T>;