@livelybone/singleton 1.2.2 → 1.3.0

package/.editorconfig

@@ -0,0 +1,31 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 2
+trim_trailing_whitespace = true
+
+[*.less]
+indent_size = 2
+
+[*.sass]
+indent_size = 2
+
+[*.scss]
+indent_size = 2
+
+[{*.bash,*.sh,*.zsh,commit-msg}]
+indent_size = 2
+tab_width = 2
+
+[{*.har,*.jsb2,*.jsb3,*.json,.babelrc,.eslintrc,.prettierrc,.stylelintrc,bowerrc,jest.config}]
+indent_size = 2
+
+[{*.htm,*.html,*.ng,*.sht,*.shtm,*.shtml}]
+indent_size = 2
+tab_width = 2

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 1.3.0 (2023-01-29)
+
+
+### Bug Fixes
+
+* **promiseOnPending:** Update ([32d73d6](https://github.com/livelybone/singleton/commit/32d73d62bd093446148c018cdc8cfa71dcd81e94))
+* type bug ([7b79ee4](https://github.com/livelybone/singleton/commit/7b79ee4d3d08a7e17ac8da79de139b49b5287b01))
+
+
+### Features
+
+* **any function:** Rename to singletonObj ([328cf74](https://github.com/livelybone/singleton/commit/328cf747c2d871215204a64a3213c1738abbc204))
+* **functions:** Seperate ([267a2c9](https://github.com/livelybone/singleton/commit/267a2c9de78fc73938eb317fe9931c959fbfe8ff))
+* **ids:** get ids from global ([9b552f2](https://github.com/livelybone/singleton/commit/9b552f23afdde11f81023168747a8e2f3a34d0ba))
+* Init ([60c3a16](https://github.com/livelybone/singleton/commit/60c3a161febd2d0f2d0b5d3de0b797196c2af852))
+* Module dev ([9ec11b7](https://github.com/livelybone/singleton/commit/9ec11b76b066a2a35155427c8c1708f0eaaec94d))
+* **singletonObj:** Update ([022c668](https://github.com/livelybone/singleton/commit/022c668b4097dba48adf4e866c617fb7b1af6ef1))
+* **ts:** Add type Fn ([021364a](https://github.com/livelybone/singleton/commit/021364a3415bba685ca464e92a2fda7a65281b9d))
+* update ([9584106](https://github.com/livelybone/singleton/commit/958410610fcfcc84b5daa065c837b3cf48a661db))
+* Update ([50cfc0c](https://github.com/livelybone/singleton/commit/50cfc0cfdc7ddc358e3cf0098ca87c224031c1e2))
+* **v1.3.0:** add singleton ([8f80e82](https://github.com/livelybone/singleton/commit/8f80e8253264680d161b566cfbc26b43534b1fe3))
+
+
+

package/README.md

@@ -1,4 +1,5 @@
 # @livelybone/singleton
+
 [![NPM Version](http://img.shields.io/npm/v/@livelybone/singleton.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/singleton)
 [![Download Month](http://img.shields.io/npm/dm/@livelybone/singleton.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/singleton)
 ![gzip with dependencies: 1kb](https://img.shields.io/badge/gzip--with--dependencies-1kb-brightgreen.svg "gzip with dependencies: 1kb")
@@ -10,25 +11,31 @@
 A util of singleton wrapping
 
 ## repository
+
 https://github.com/livelybone/singleton.git
 
 ## Demo
+
 https://github.com/livelybone/singleton#readme
 
 ## Installation
+
 ```bash
 npm i -S @livelybone/singleton
 ```
 
 ## Global name
+
 `Singleton`
 
 ## Usage
+
 ```js
 import * as Singleton from '@livelybone/singleton'
 ```
 
 Use in html, see what your can use in [CDN: unpkg](https://unpkg.com/@livelybone/singleton/lib/umd/)
+
 ```html
 <-- use what you want -->
 <script src="https://unpkg.com/@livelybone/singleton/lib/umd/<--module-->.js"></script>
@@ -45,7 +52,7 @@ declare type Fn<T = any> = () => T
  * */
 declare type ID = string | number
 
-interface PromiseOnPendingOptions {
+export interface PromiseOnPendingOptions {
   id?: ID
   /**
    * 用于延迟 Promise 实例删除，
@@ -53,16 +60,40 @@ interface PromiseOnPendingOptions {
    *
    * Used to delay the deletion of Promise instance,
    * if it is undefined, the promise will be deleted immediately after the state changed
+   *
+   * This option will be deprecated in next version
    * */
   delayTime?: number
+  /**
+   * 同 delayTime
+   * 推荐使用这个属性
+   *
+   * As same as delayTime
+   * */
+  cacheTime?: number
 }
 
 /**
- * @desc 返回 id 对应的一个对象
+ * @deprecated 这个方法使用多了会导致内存泄漏，建议使用 singleton 方法代替
+ * @desc 返回 id 对应的一个单例对象
+ *
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
+ * */
+declare function singletonObj<T extends any>(id: ID, defaultValue?: () => T): T
+
+/**
+ * @desc 返回 id 对应的一个单例对象，这个方法应当配合返回的 delete 方法一起使用，否则使用多了会导致内存泄漏
  *
- *       Return a singleton of any object(such as Promise, Function, Object...) corresponding to the id
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
+ *       This method will cause OOM if it's used too much without calling `delete`.
  * */
-declare function singletonObj<T = {}>(id: ID, defaultValue?: () => T): T
+declare function singleton<T extends any>(
+  id: ID,
+  defaultValue?: () => T,
+): {
+  value: T
+  delete(): void
+}
 
 /**
  * @desc 保证一个 id 对应的 promise 在同一时间只存在一个，
@@ -74,10 +105,10 @@ declare function singletonObj<T = {}>(id: ID, defaultValue?: () => T): T
  *       during the period of promise pending.
  *       This method can be used to reduce redundant requests at the same time
  * */
-declare function promiseOnPending<T = any>(
-  proFn: () => Promise<T>,
+declare function promiseOnPending<P extends PromiseLike<any>>(
+  proFn: () => P,
   options: PromiseOnPendingOptions,
-): Promise<T>
+): P
 
 /**
  * @desc 封装 setInterval 函数，
@@ -97,5 +128,5 @@ declare function runInterval(id: ID, createFn: Fn): () => void
  * */
 declare function onceRun(fn: Fn, id?: any): void
 
-export { onceRun, promiseOnPending, runInterval, singletonObj }
+export { onceRun, promiseOnPending, runInterval, singleton, singletonObj }
 ```

package/index.d.ts

@@ -28,12 +28,27 @@ export interface PromiseOnPendingOptions {
 }
 
 /**
- * @desc 返回 id 对应的一个对象
+ * @deprecated 这个方法使用多了会导致内存泄漏，建议使用 singleton 方法代替
+ * @desc 返回 id 对应的一个单例对象
  *
- *       Return a singleton of any object(such as Promise, Function, Object...) corresponding to the id
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
  * */
 declare function singletonObj<T extends any>(id: ID, defaultValue?: () => T): T
 
+/**
+ * @desc 返回 id 对应的一个单例对象，这个方法应当配合返回的 delete 方法一起使用，否则使用多了会导致内存泄漏
+ *
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
+ *       This method will cause OOM if it's used too much without calling `delete`.
+ * */
+declare function singleton<T extends any>(
+  id: ID,
+  defaultValue?: () => T,
+): {
+  value: T
+  delete(): void
+}
+
 /**
  * @desc 保证一个 id 对应的 promise 在同一时间只存在一个，
  *       并且生成 promise 的函数在 promise pending 状态的时间段内只执行一次，
@@ -67,4 +82,4 @@ declare function runInterval(id: ID, createFn: Fn): () => void
  * */
 declare function onceRun(fn: Fn, id?: any): void
 
-export { onceRun, promiseOnPending, runInterval, singletonObj }
+export { onceRun, promiseOnPending, runInterval, singleton, singletonObj }

package/lib/es/index.js

@@ -1,7 +1,7 @@
 /**
  * Bundle of @livelybone/singleton
- * Generated: 2021-02-09
- * Version: 1.2.2
+ * Generated: 2023-01-29
+ * Version: 1.3.0
  * License: MIT
  * Author: 2631541504@qq.com
  */
@@ -11,32 +11,50 @@
  *
  * The id of a singleton
  * */
+
 function getIdsMap() {
   var $global = typeof window !== 'undefined' ? window : global;
-
   if (!$global.$$SingletonIdsMap || !($global.$$SingletonIdsMap instanceof Map)) {
     $global.$$SingletonIdsMap = new Map();
   }
-
   return $global.$$SingletonIdsMap;
 }
+
 /**
- * @desc 返回 id 对应的一个对象
+ * @deprecated 这个方法使用多了会导致内存泄漏，建议使用 singleton 方法代替
+ * @desc 返回 id 对应的一个单例对象
  *
- *       Return a singleton of any object(such as Promise, Function, Object...) corresponding to the id
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
  * */
-
-
 function singletonObj(id, defaultValue) {
   var ids = getIdsMap();
   var k = "singleton-any-".concat(id || 'default');
-
   if (!ids.has(k)) {
     ids.set(k, defaultValue ? defaultValue() : {});
   }
-
   return ids.get(k);
 }
+
+/**
+ * @desc 返回 id 对应的一个单例对象，这个方法应当配合返回的 delete 方法一起使用，否则使用多了会导致内存泄漏
+ *
+ *       Return a singleton of an object(such as Promise, Function, Object...) corresponding to the id.
+ *       This method will cause OOM if it's used too much without calling `delete`.
+ * */
+function singleton(id, defaultValue) {
+  var ids = getIdsMap();
+  var k = "singleton-any-".concat(id || 'default');
+  if (!ids.has(k)) {
+    ids.set(k, defaultValue ? defaultValue() : {});
+  }
+  return {
+    value: ids.get(k),
+    delete: function _delete() {
+      return ids.delete(id);
+    }
+  };
+}
+
 /**
  * @desc 保证一个 id 对应的 promise 在同一时间只存在一个，
  *       并且生成 promise 的函数在 promise pending 状态的时间段内只执行一次，
@@ -47,22 +65,18 @@ function singletonObj(id, defaultValue) {
  *       during the period of promise pending.
  *       This method can be used to reduce redundant requests at the same time
  * */
-
 function promiseOnPending(proFn, options) {
   var ids = getIdsMap();
   var id = options.id;
   var cacheTime = options.cacheTime || options.delayTime;
   var k = id ? "promise-".concat(id) : proFn;
-
   var del = function del() {
     return ids.delete(k);
   };
-
   var del1 = function del1() {
     if (cacheTime === undefined) del();else setTimeout(del, cacheTime);
     return true;
   };
-
   if (!ids.has(k)) {
     ids.set(k, proFn().then(function (res) {
       return del1() && res;
@@ -70,9 +84,9 @@ function promiseOnPending(proFn, options) {
       return Promise.reject(del1() && e);
     }));
   }
-
   return ids.get(k);
 }
+
 /**
  * @desc 封装 setInterval 函数，
  *       保证同一个 id 对应的计时器只有一个在运行，
@@ -82,16 +96,13 @@ function promiseOnPending(proFn, options) {
  *       make sure only one timer for the same id is running,
  *       and returns a function to clear the timer so it can be terminated at any time
  * */
-
 function runInterval(id, createFn) {
   var ids = getIdsMap();
   var k = "timer-".concat(id || 'default');
-
   if (ids.has(k)) {
     // clear old interval
     ids.get(k)();
   }
-
   var $id = createFn();
   ids.set(k, function () {
     clearInterval($id);
@@ -99,19 +110,18 @@ function runInterval(id, createFn) {
   });
   return ids.get(k);
 }
+
 /**
  * @desc 保证传入的函数在程序的运行期间只运行一次
  *
  *       Ensure that the incoming function runs only once during the run time of the program
  * */
-
 function onceRun(fn, id) {
   var ids = getIdsMap();
   var k = id ? "once-run-".concat(id) : fn;
-
   if (!ids.has(k)) {
     ids.set(k, fn());
   }
 }
 
-export { onceRun, promiseOnPending, runInterval, singletonObj };
+export { onceRun, promiseOnPending, runInterval, singleton, singletonObj };

package/lib/umd/index.js

@@ -1,9 +1,9 @@
 /**
  * Bundle of @livelybone/singleton
- * Generated: 2021-02-09
- * Version: 1.2.2
+ * Generated: 2023-01-29
+ * Version: 1.3.0
  * License: MIT
  * Author: 2631541504@qq.com
  */
 
-!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports):"function"==typeof define&&define.amd?define(["exports"],n):n((e=e||self).Singleton={})}(this,function(e){"use strict";function c(){var e="undefined"!=typeof window?window:global;return e.$$SingletonIdsMap&&e.$$SingletonIdsMap instanceof Map||(e.$$SingletonIdsMap=new Map),e.$$SingletonIdsMap}e.onceRun=function(e,n){var t=c(),n=n?"once-run-".concat(n):e;t.has(n)||t.set(n,e())},e.promiseOnPending=function(e,n){function t(){return i.delete(a)}function o(){return void 0===u?t():setTimeout(t,u),!0}var i=c(),r=n.id,u=n.cacheTime||n.delayTime,a=r?"promise-".concat(r):e;return i.has(a)||i.set(a,e().then(function(e){return o(),e},function(e){return Promise.reject((o(),e))})),i.get(a)},e.runInterval=function(e,n){var t=c(),o="timer-".concat(e||"default");t.has(o)&&t.get(o)();var i=n();return t.set(o,function(){clearInterval(i),t.delete(o)}),t.get(o)},e.singletonObj=function(e,n){var t=c(),e="singleton-any-".concat(e||"default");return t.has(e)||t.set(e,n?n():{}),t.get(e)},Object.defineProperty(e,"__esModule",{value:!0})});
+!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports):"function"==typeof define&&define.amd?define(["exports"],n):n((e=e||self).Singleton={})}(this,function(e){"use strict";function c(){var e="undefined"!=typeof window?window:global;return e.$$SingletonIdsMap&&e.$$SingletonIdsMap instanceof Map||(e.$$SingletonIdsMap=new Map),e.$$SingletonIdsMap}e.onceRun=function(e,n){var t=c(),n=n?"once-run-".concat(n):e;t.has(n)||t.set(n,e())},e.promiseOnPending=function(e,n){function t(){return i.delete(a)}function o(){return void 0===u?t():setTimeout(t,u),!0}var i=c(),r=n.id,u=n.cacheTime||n.delayTime,a=r?"promise-".concat(r):e;return i.has(a)||i.set(a,e().then(function(e){return o(),e},function(e){return Promise.reject((o(),e))})),i.get(a)},e.runInterval=function(e,n){var t=c(),o="timer-".concat(e||"default"),i=(t.has(o)&&t.get(o)(),n());return t.set(o,function(){clearInterval(i),t.delete(o)}),t.get(o)},e.singleton=function(e,n){var t=c(),o="singleton-any-".concat(e||"default");return t.has(o)||t.set(o,n?n():{}),{value:t.get(o),delete:function(){return t.delete(e)}}},e.singletonObj=function(e,n){var t=c(),e="singleton-any-".concat(e||"default");return t.has(e)||t.set(e,n?n():{}),t.get(e)},Object.defineProperty(e,"__esModule",{value:!0})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livelybone/singleton",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "A util of singleton wrapping",
   "main": "./lib/umd/index.js",
   "module": "./lib/es/index.js",