koatty_schedule 1.6.0 → 2.0.1

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 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.
 
+### [2.0.1](https://github.com/thinkkoa/koatty_schedule/compare/v2.0.0...v2.0.1) (2024-01-17)
+
+## [2.0.0](https://github.com/thinkkoa/koatty_schedule/compare/v1.6.0...v2.0.0) (2024-01-17)
+
+
+### Refactor
+
+* redlock ([beb7cd9](https://github.com/thinkkoa/koatty_schedule/commit/beb7cd90878319cb1c480f4ad11b2632c184872b))
+* redlock ([ea29337](https://github.com/thinkkoa/koatty_schedule/commit/ea29337052aee081322918914876a95923d314ae))
+
 ## [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)

package/dist/index.d.ts

@@ -1,47 +1,45 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-20 19:48:19
+* @Date: 2024-01-17 13:24:21
 * @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 {RedLockOptions} [options]
+ *
+ * lockTimeOut ?: number; lock a resource times
+ *
+ * retryCount ?: number; The max number of times Redlock will attempt to lock a resource
  *
+ * RedisOptions: RedisOptions; redis config
  * @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;
+    /**
+     * redis config
+     */
+    RedisOptions: RedisOptions;
 }
 
 /**
@@ -49,28 +47,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 { }