koatty_schedule 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  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.
4
4
 
5
+ ### [2.0.1](https://github.com/thinkkoa/koatty_schedule/compare/v2.0.0...v2.0.1) (2024-01-17)
6
+
5
7
  ## [2.0.0](https://github.com/thinkkoa/koatty_schedule/compare/v1.6.0...v2.0.0) (2024-01-17)
6
8
 
7
9
 
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2024-01-17 13:04:42
3
+ * @Date: 2024-01-17 13:24:21
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
@@ -12,9 +12,13 @@ import { RedisOptions } from 'ioredis';
12
12
  *
13
13
  * @export
14
14
  * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
15
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time. default 10000
16
- * @param {number} [waitLockRetry] Try to acquire lock max time. default 3
15
+ * @param {RedLockOptions} [options]
17
16
  *
17
+ * lockTimeOut ?: number; lock a resource times
18
+ *
19
+ * retryCount ?: number; The max number of times Redlock will attempt to lock a resource
20
+ *
21
+ * RedisOptions: RedisOptions; redis config
18
22
  * @returns {MethodDecorator}
19
23
  */
20
24
  export declare function RedLock(name?: string, options?: RedLockOptions): MethodDecorator;
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2024-01-17 13:04:31
3
+ * @Date: 2024-01-17 13:24:10
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
@@ -354,9 +354,13 @@ function Scheduled(cron, timezone = 'Asia/Beijing') {
354
354
  *
355
355
  * @export
356
356
  * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
357
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time. default 10000
358
- * @param {number} [waitLockRetry] Try to acquire lock max time. default 3
357
+ * @param {RedLockOptions} [options]
359
358
  *
359
+ * lockTimeOut ?: number; lock a resource times
360
+ *
361
+ * retryCount ?: number; The max number of times Redlock will attempt to lock a resource
362
+ *
363
+ * RedisOptions: RedisOptions; redis config
360
364
  * @returns {MethodDecorator}
361
365
  */
362
366
  function RedLock(name, options) {
package/dist/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * @Author: richen
3
- * @Date: 2024-01-17 13:04:31
3
+ * @Date: 2024-01-17 13:24:10
4
4
  * @License: BSD (3-Clause)
5
5
  * @Copyright (c) - <richenlin(at)gmail.com>
6
6
  * @HomePage: https://koatty.org/
@@ -334,9 +334,13 @@ function Scheduled(cron, timezone = 'Asia/Beijing') {
334
334
  *
335
335
  * @export
336
336
  * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
337
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time. default 10000
338
- * @param {number} [waitLockRetry] Try to acquire lock max time. default 3
337
+ * @param {RedLockOptions} [options]
339
338
  *
339
+ * lockTimeOut ?: number; lock a resource times
340
+ *
341
+ * retryCount ?: number; The max number of times Redlock will attempt to lock a resource
342
+ *
343
+ * RedisOptions: RedisOptions; redis config
340
344
  * @returns {MethodDecorator}
341
345
  */
342
346
  function RedLock(name, options) {
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "koatty_schedule",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Schedule for koatty.",
5
5
  "scripts": {
6
6
  "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "koatty_schedule",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Schedule for koatty.",
5
5
  "scripts": {
6
6
  "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",