@zenweb/schedule 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 3.7.0
+- paths 支持使用 "./" 开头的相对路径
+
+## 3.6.1
+- null 检查

package/README.md

@@ -2,10 +2,27 @@
 
 [ZenWeb](https://www.npmjs.com/package/zenweb)
 
-定时任务
+基于请求的定时任务，如同定时请求固定接口，可以使用中间件和请求上下文。
 
-```ts
-import { Context } from 'zenweb';
+## 依赖模块
+
+- @zenweb/inject
+- @zenweb/router
+
+## 快速使用
+
+```bash npm2yarn
+npm install @zenweb/schedule
+```
+
+```ts title="src/index.ts"
+import modSchedule from '@zenweb/schedule';
+// ...
+app.setup(modSchedule());
+// ...
+```
+
+```ts title="src/schedule/echo.ts"
 import { schedule } from '@zenweb/schedule';
 
 export class EchoScheduler {
@@ -14,10 +31,19 @@ export class EchoScheduler {
     console.log('task echo');
     return 'ok';
   }
-
-  @schedule({ rule: '*/4 * * * * *' })
-  err(ctx: Context) {
-    ctx.errrrr();
-  }
 }
-```
+```
+
+## 配置项
+
+| 配置项 | 类型 | 默认值 | 功能 |
+| ----- | --- | ----- | ---- |
+| paths | `string[]` | `['./app/schedule']` | 定时任务控制器加载目录
+| patterns | `string` | **/*.{ts,js} | 定时任务控制器文件匹配规则
+| disabled | `boolean` | `false` | 是否禁用定时器，可以通过环境变量 ZENWEB_SCHEDULE_DISABLED=1 控制
+
+## Core 挂载项
+
+| 挂载项 | 类型 | 功能 |
+| ----- | --- | ---- |
+| scheduleRegister | ScheduleRegister | ScheduleRegister 实例

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { SetupFunction } from '@zenweb/core';
 import { schedule, ScheduleRegister } from './register';
 import { ScheduleOption } from './types';
 export { ScheduleOption, schedule };
-export default function setup(option?: ScheduleOption): SetupFunction;
+export default function setup(opt?: ScheduleOption): SetupFunction;
 declare module '@zenweb/core' {
     interface Core {
         scheduleRegister: ScheduleRegister;

package/dist/index.js

@@ -5,11 +5,11 @@ const globby = require("globby");
 const path = require("path");
 const register_1 = require("./register");
 Object.defineProperty(exports, "schedule", { enumerable: true, get: function () { return register_1.schedule; } });
-function setup(option) {
-    option = Object.assign({
-        paths: [path.join(process.cwd(), 'app', 'schedule')],
+function setup(opt) {
+    const option = Object.assign({
+        paths: ['./app/schedule'],
         disabled: process.env.ZENWEB_SCHEDULE_DISABLED === '1',
-    }, option);
+    }, opt);
     return async function schedule(setup) {
         setup.assertModuleExists('inject', '@zenweb/inject');
         setup.assertModuleExists('router', '@zenweb/router');
@@ -17,7 +17,10 @@ function setup(option) {
         const scheduleRegister = new register_1.ScheduleRegister(setup.core, option);
         setup.defineCoreProperty('scheduleRegister', { value: scheduleRegister });
         if (option.paths && option.paths.length) {
-            for (const d of option.paths) {
+            for (let d of option.paths) {
+                if (d.startsWith('./')) {
+                    d = path.join(process.cwd(), d.slice(2));
+                }
                 for (const file of await globby(option.patterns || '**/*.{ts,js}', { cwd: d, absolute: true })) {
                     const mod = require(file.slice(0, -3));
                     for (const i of Object.values(mod)) {

package/dist/register.d.ts

@@ -8,7 +8,7 @@ interface ScheduleMethodOption {
 /**
  * 定时任务设定
  */
-export declare function schedule(opt: ScheduleMethodOption): (target: Object, propertyKey: string | symbol, descriptor_or_paramtypes?: any[] | PropertyDescriptor) => void;
+export declare function schedule(opt: ScheduleMethodOption): (target: Object, propertyKey: string | symbol, descriptor_or_paramtypes?: any[] | PropertyDescriptor | undefined) => void;
 export declare class ScheduleRegister {
     private core;
     private router;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenweb/schedule",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Zenweb Schedule module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -34,7 +34,7 @@
     "url": "https://github.com/yefei/zenweb-schedule/issues"
   },
   "devDependencies": {
-    "@zenweb/core": "^3.5.0",
+    "@zenweb/core": "^3.5.1",
     "@zenweb/inject": "^3.18.0",
     "@zenweb/router": "^3.3.0",
     "cross-env": "^7.0.3",