koatty_schedule 1.5.11 → 1.6.2

package/.rollup.config.js

@@ -3,61 +3,58 @@
  * @Usage: 
  * @Author: richen
  * @Date: 2021-12-17 10:20:44
- * @LastEditTime: 2021-12-18 11:58:46
+ * @LastEditTime: 2024-11-04 22:04:45
  */
+import commonjs from '@rollup/plugin-commonjs';
 import json from "@rollup/plugin-json";
+import resolve from '@rollup/plugin-node-resolve';
+import { builtinModules } from 'module';
+import del from "rollup-plugin-delete";
 import typescript from 'rollup-plugin-typescript2';
 // import babel from '@rollup/plugin-babel';
+const pkg = require('./package.json');
 
 export default [
-    {
-        input: './src/index.ts',
-        output: [{
-            format: 'cjs',
-            file: './dist/index.js',
-            banner: require('./scripts/copyright')
-        }],
-        plugins: [
-            // babel({
-            //     babelHelpers: "runtime",
-            //     configFile: './babel.config.js',
-            //     exclude: 'node_modules/**',
-            // }),
-            json(),
-            typescript({
-                tsconfigOverride: {
-                    compilerOptions: {
-                        declaration: false,
-                        declarationMap: false,
-                        module: "ESNext"
-                    }
-                }
-            })
-        ]
-    },
-    {
-        input: './src/index.ts',
-        output: [{
-            format: 'es',
-            file: './dist/index.mjs',
-            banner: require('./scripts/copyright')
-        }],
-        plugins: [
-            // babel({
-            //     babelHelpers: "runtime",
-            //     configFile: './babel.config.js',
-            //     exclude: 'node_modules/**',
-            // }),
-            json(),
-            typescript({
-                tsconfigOverride: {
-                    compilerOptions: {
-                        declaration: false,
-                        declarationMap: false,
-                        module: "ESNext"
-                    }
-                }
-            })
-        ]
-    }
+  {
+    input: './src/index.ts',
+    output: [
+      {
+        format: 'cjs',
+        file: './dist/index.js',
+        banner: require('./scripts/copyright'),
+      },
+      {
+        format: 'es',
+        file: './dist/index.mjs',
+        banner: require('./scripts/copyright'),
+      },
+    ],
+    plugins: [
+      del({ targets: ["dist/*", "temp/*", "docs/api"] }),
+      // babel({
+      //     babelHelpers: "runtime",
+      //     configFile: './babel.config.js',
+      //     exclude: 'node_modules/**',
+      // }),
+      json(),
+      resolve({
+        preferBuiltins: true, // 优先选择内置模块
+      }),
+      commonjs(),
+      typescript({
+        tsconfigOverride: {
+          compilerOptions: {
+            declaration: false,
+            declarationMap: false,
+            module: "ESNext"
+          }
+        }
+      })
+    ],
+    external: [
+      ...builtinModules, // 排除 Node.js 内置模块
+      ...Object.keys(pkg.dependencies || {}), // 排除 package.json 中的外部依赖
+    ],
+  },
+
 ]

package/CHANGELOG.md

@@ -2,8 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [1.5.11](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.10...v1.5.11) (2023-07-28)
+### [1.6.2](https://github.com/thinkkoa/koatty_schedule/compare/v1.6.0...v1.6.2) (2024-11-07)
 
+## [1.6.0](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.11...v1.6.0) (2023-12-20)
+
+### [1.5.11](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.10...v1.5.11) (2023-07-28)
+
 ### [1.5.10](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.8...v1.5.10) (2023-01-13)
 
 ### [1.5.8](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.7...v1.5.8) (2022-11-03)

package/dist/index.d.ts

@@ -1,47 +1,46 @@
 /*!
 * @Author: richen
-* @Date: 2023-07-28 21:05:33
+* @Date: 2024-11-07 16:50:50
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
-import { Application } from 'koatty_container';
-
-/**
- * get instances of cacheStore
- *
- * @export
- * @param {Application} app
- * @returns {*}  {CacheStore}
- */
-export declare function GetScheduleLocker(app: Application): Promise<LockerInterface>;
-
-/**
- * Inject schedule job
- *
- * @export
- * @param {*} target
- */
-export declare function injectSchedule(target: any): void;
+import { RedisOptions } from 'ioredis';
 
 /**
  * Redis-based distributed locks. Redis server config from db.ts.
  *
  * @export
  * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time.
- * @param {number} [waitLockInterval] Try to acquire lock every interval time(millisecond).
- * @param {number} [waitLockTimeOut] When using more than TimeOut(millisecond) still fails to get the lock and return failure.
+ * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time. default 10000
+ * @param {number} [waitLockRetry] Try to acquire lock max time. default 3
  *
  * @returns {MethodDecorator}
  */
-export declare const Lock: typeof SchedulerLock;
+export declare function RedLock(name?: string, options?: RedLockOptions): MethodDecorator;
 
-declare interface LockerInterface {
-    getClient?: () => Promise<any>;
-    lock?: (key: string, expire?: number) => Promise<boolean>;
-    waitLock?: (key: string, expire: number, interval?: number, waitTime?: number) => Promise<boolean>;
-    unLock?: (key: string) => Promise<boolean>;
+/**
+ * @description: RedLockOptions
+ * @return {*}
+ */
+declare interface RedLockOptions {
+    /**
+     * lock a resource times
+     */
+    lockTimeOut?: number;
+    /**
+     * The max number of times Redlock will attempt to lock a resource
+     */
+    retryCount?: number;
+    /**
+     * If there is a lock timeout, renew the lock and retry execution,
+     *  with a maximum of maxRetry attempts.
+     */
+    renewCount?: number;
+    /**
+     * redis config
+     */
+    RedisOptions: RedisOptions;
 }
 
 /**
@@ -49,28 +48,16 @@ declare interface LockerInterface {
  *
  * @export
  * @param {string} cron
+ * @param {string} _timezone
  * * Seconds: 0-59
  * * Minutes: 0-59
  * * Hours: 0-23
  * * Day of Month: 1-31
- * * Months: 0-11 (Jan-Dec)
- * * Day of Week: 0-6 (Sun-Sat)
- *
- * @returns {MethodDecorator}
- */
-export declare function Scheduled(cron: string): MethodDecorator;
-
-/**
- * Redis-based distributed locks. Redis server config from db.ts.
- *
- * @export
- * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time.
- * @param {number} [waitLockInterval] Try to acquire lock every interval time(millisecond).
- * @param {number} [waitLockTimeOut] When using more than TimeOut(millisecond) still fails to get the lock and return failure.
+ * * Months: 1-12 (Jan-Dec)
+ * * Day of Week: 1-7 (Sun-Sat)
  *
  * @returns {MethodDecorator}
  */
-export declare function SchedulerLock(name?: string, lockTimeOut?: number, waitLockInterval?: number, waitLockTimeOut?: number): MethodDecorator;
+export declare function Scheduled(cron: string, _timezone?: string): MethodDecorator;
 
 export { }