koatty_schedule 1.5.5 → 1.5.6

package/.rollup.config.js

@@ -0,0 +1,63 @@
+/*
+ * @Description: 
+ * @Usage: 
+ * @Author: richen
+ * @Date: 2021-12-17 10:20:44
+ * @LastEditTime: 2021-12-18 11:58:46
+ */
+import json from "@rollup/plugin-json";
+import typescript from 'rollup-plugin-typescript2';
+// import babel from '@rollup/plugin-babel';
+
+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"
+                    }
+                }
+            })
+        ]
+    }
+]

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.6](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.5...v1.5.6) (2022-05-27)
+
 ### [1.5.5](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.4...v1.5.5) (2022-03-02)
 
 ### [1.5.4](https://github.com/thinkkoa/koatty_schedule/compare/v1.5.2...v1.5.4) (2021-12-09)

package/dist/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Koatty
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/README.md

@@ -0,0 +1,48 @@
+# koatty_schedule
+Schedule for koatty.
+
+Koatty框架的 Scheduled, SchedulerLock, Lock 支持库
+
+
+# Usage
+
+db.ts in koatty project:
+
+```js
+export default {
+    ...
+
+    "CacheStore": {
+        type: "memory", // redis or memory, memory is default
+        // key_prefix: "koatty",
+        // host: '127.0.0.1',
+        // port: 6379,
+        // name: "",
+        // username: "",
+        // password: "",
+        // db: 0,
+        // timeout: 30,
+        // pool_size: 10,
+        // conn_timeout: 30
+    },
+
+    ...
+};
+
+```
+
+used in service: 
+
+```js
+import { Scheduled, SchedulerLock } from "koatty_schedule";
+
+export class TestService {
+
+    @Scheduled("0 * * * * *")
+    @SchedulerLock("testCron") //locker
+    Test(){
+        //todo
+    }
+}
+
+```

package/dist/index.d.ts

@@ -1,69 +1,76 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: MIT
- * @ version: 2020-07-06 10:30:11
- */
-import "reflect-metadata";
-import { Application } from "koatty_container";
-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>;
-}
-/**
- * get instances of cacheStore
- *
- * @export
- * @param {Application} app
- * @returns {*}  {CacheStore}
- */
-export declare function GetScheduleLocker(app: Application): Promise<LockerInterface>;
-/**
- * Schedule task
- *
- * @export
- * @param {string} cron
- * * 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.
- *
- * @returns {MethodDecorator}
- */
-export declare function SchedulerLock(name?: string, lockTimeOut?: number, waitLockInterval?: number, waitLockTimeOut?: number): 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.
- *
- * @returns {MethodDecorator}
- */
-export declare const Lock: typeof SchedulerLock;
-/**
- * Inject schedule job
- *
- * @export
- * @param {*} target
- */
-export declare function injectSchedule(target: any): void;
-export {};
+/*!
+* @Author: richen
+* @Date: 2022-05-27 10:10:24
+* @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;
+
+/**
+ * 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.
+ *
+ * @returns {MethodDecorator}
+ */
+export declare const Lock: typeof SchedulerLock;
+
+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>;
+}
+
+/**
+ * Schedule task
+ *
+ * @export
+ * @param {string} cron
+ * * 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.
+ *
+ * @returns {MethodDecorator}
+ */
+export declare function SchedulerLock(name?: string, lockTimeOut?: number, waitLockInterval?: number, waitLockTimeOut?: number): MethodDecorator;
+
+export { }