a-js-tools 2.0.0 → 2.0.2

package/es/{src → types}/getRandomNumber.d.ts

@@ -1,6 +1,5 @@
 /**
- *
- * 获取一个随机的整数类型
+ * ## 获取一个随机的整数类型
  *
  * 您可以传入两个参数并获取它们之间的任意数字，返回值<span style="color:#ff0;">*会包含端值*</span>
  *
@@ -12,8 +11,7 @@
  */
 export declare function getRandomInt(max?: number, min?: number): number;
 /**
- *
- * 获取任意的浮点数
+ * ## 获取任意的浮点数
  *
  * 您可以传入两个参数并获取它们之间的任意数字
  *

package/es/{src → types}/getRandomString.d.ts

@@ -1,7 +1,5 @@
 /**
- *
- *  随机字符串 生成器
- *
+ *  随机字符串生成器
  */
 export type RandomStringOptions = {
     /**
@@ -43,12 +41,17 @@ export type RandomStringOptions = {
     type?: 'string' | 'uuid';
 };
 /**
+ * 获取简单的随机字符串
  *
- *  获取简单的随机字符串
- *
- *  @param   options - 字符串长度
- *  @returns  - 随机字符串
- *
+ * @param  options - 字符串生成参数
+ * @returns  - 随机字符串
+ * @example
+ * ```ts
+ * import { getRandomString } from 'a-js-tools';
  *
+ * // 获取简单的随机字符串
+ * // 'abcdefg'
+ * // getRandomString(7);
+ * ```
  */
 export declare function getRandomString(options?: RandomStringOptions | number): string;

package/es/{src → types}/isNode.d.ts

@@ -1,12 +1,8 @@
 /**
- *
  * 判断当前环境是否为 node 环境
- *
  */
 export declare function isNode(): boolean;
 /**
- *
  * 是否为浏览器环境
- *
  */
 export declare function isBrowser(): boolean;

package/es/{src → types}/object/createConstructor.d.ts

@@ -1,15 +1,11 @@
 /**
- *
  * 构建构建的构建函数
- *
- *
  */
 export interface CreateConstructor<T, Args extends unknown[] = unknown[]> {
     new (...args: Args): T;
 }
 /**
- *
- * 构建一个 Constructor 构造函数
+ * # 构建一个 Constructor 构造函数
  *
  * 接收一个构造函数，然后返回 TS 能识别的构造函数自身
  *
@@ -19,7 +15,7 @@ export interface CreateConstructor<T, Args extends unknown[] = unknown[]> {
  *
  * @param constructor - 传入一个构造函数
  * @returns 返回传入的构造函数
- *
+ * @example
  * ```ts
  * import { createConstructor } from "a-js-tools";
  *
@@ -40,9 +36,7 @@ export interface CreateConstructor<T, Args extends unknown[] = unknown[]> {
  * const tomConstructor = createConstructor(_tom);
  *
  * const b = new tomConstructor(); // 这时就不会显示错误
- *
  * ```
- *
  */
 export declare function createConstructor<T, Args extends unknown[] = unknown[]>(constructor: (...argumentList: Args) => T): CreateConstructor<T, Args>;
 /** 对象的 assign 用法 */

package/es/{src → types}/performance.d.ts

@@ -1,15 +1,6 @@
-/**
- * 防抖和节流
- *
- * @packageDocumentation
- * @module @a-js-tools/performance
- * @license MIT
- */
 type Callback = (...args: any[]) => void;
 /**
- *
  * 节流和防抖返回值类型
- *
  */
 export interface DebounceAndThrottleReturnType<F extends Callback> {
     (...args: Parameters<F>): void;
@@ -21,7 +12,6 @@ export type debounce_throttle_options = {
     this?: null | unknown;
 } | number;
 /**
- *
  * 防抖
  *
  * @param   callback 回调函数
@@ -32,15 +22,14 @@ export type debounce_throttle_options = {
  * ```ts
  * const debounce = (callback: Function, delay = 300) => {
  *   let timer: any = null
- *   return (...args: any[]) => {
- *     clearTimeout(timer)
- *   }
- * }
  *
+ *   return (...args: any[]) => clearTimeout(timer)
+ * }
+ * ```
  */
 export declare function debounce<F extends Callback>(callback: F, options?: debounce_throttle_options): DebounceAndThrottleReturnType<F>;
 /**
- *   节流
+ * 节流
  *
  * @param callback   回调函数
  * @param options      延迟时间（毫秒），默认 200 (ms) 或设置 this

package/es/{src → types}/regexp/autoEscapedRegExp.d.ts

@@ -1,7 +1,6 @@
 import { autoEscapedRegExpOptions } from './types';
 /**
- *
- * ##  适用于简单的文本字符串自动转化为简单模式正则表达式
+ * ## 适用于简单的文本字符串自动转化为简单模式正则表达式
  *
  * *若字符串包含且需保留字符类、组、反向引用、量词等时，该方法可能不适用*
  *
@@ -9,7 +8,6 @@ import { autoEscapedRegExpOptions } from './types';
  * @param options 转化选项。 为文本字符串时，默认为正则表达式的标志，还可指定是否匹配开头或结尾
  * @returns 正则表达式
  * @example
- *
  * ```ts
  * import { autoEscapedRegExp } from 'a-regexp';
  *
@@ -25,8 +23,6 @@ import { autoEscapedRegExpOptions } from './types';
  * autoEscapedRegExp('a-zA-Z0-9', 'g'); // => /a-zA-Z0-9/g
  * autoEscapedRegExp('[a-zA-Z0-9]'); // => /\[a-zA-Z0-9\]/
  * autoEscapedRegExp('^[a-zA-Z0-9]+$'); // => /\^\[a-zA-Z0-9\]\$/
- *
  * ```
- *
  */
 export declare function autoEscapedRegExp(pattern: string, options?: string | autoEscapedRegExpOptions): RegExp;

package/es/types/regexp/escapeRegExp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * # 将一个字符串转化为符合正则要求的字符串
+ *
+ * @param str 需要转义的字符串
+ * @requires escapeRegExp 转化后字符串
+ * @example
+ * ```ts
+ * import { escapeRegExp  } from 'a-js-tools';
+ *
+ * escapeRegExp('a.b.c'); // 'a\\.b\\.c'
+ * escapeRegExp('a\\.b\\.c'); // 'a\\\\.b\\\\.c'
+ * escapeRegExp('[a-z]'); // '\\[a-z\\]'
+ * escapeRegExp('^abc$'); // '\\^abc\\$'
+ * ```
+ */
+export declare function escapeRegExp(str: string): string;

package/es/{src → types}/regexp/parse.d.ts

@@ -1,7 +1,5 @@
 import { autoEscapedRegExpOptions } from './types';
 /**
- *
  * 解析 options
- *
  */
 export declare function parse(options: string | autoEscapedRegExpOptions): autoEscapedRegExpOptions;

package/es/{src → types}/regexp/types.d.ts

@@ -1,14 +1,9 @@
 export interface autoEscapedRegExpOptions {
     /**
-     *
-     *
-     *
      */
     flags?: string;
     /**
-     *
      * 匹配开头
-     *
      */
     start?: boolean;
     end?: boolean;

package/es/{src → types}/sleep.d.ts

@@ -1,5 +1,4 @@
 /**
- *
  * ## 线程休息
  *
  * 但从调用到执行完毕总是与期望的时间并不相吻合，除非执行是线型的（也不保证时间的严格性）
@@ -19,8 +18,6 @@
  * console.log(Date.now()); // 1748058118471
  * await sleep(1000);
  * console.log(Date.now()); // 1748058119473
- *
  * ```
- *
  */
 export declare function sleep(delay?: number): Promise<void>;

package/package.json

@@ -1,18 +1,18 @@
 {
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "name": "a-js-tools",
   "license": "MIT",
   "dependencies": {
-    "a-type-of-js": "^2.0.0"
+    "a-type-of-js": "^2.0.1"
   },
   "main": "cjs/index.js",
   "module": "es/index.js",
-  "types": "es/index.d.ts",
+  "types": "es/types/index.d.ts",
   "author": {
     "name": "泥豆君",
     "email": "Mr.MudBean@outlook.com",
-    "url": "https://earthnut.dev"
+    "url": "https://lmssee.com"
   },
   "description": "一点点 🤏  js 函数",
   "sideEffects": false,
@@ -30,67 +30,61 @@
       "import": "./es/index.js",
       "default": "./es/index.js",
       "require": "./cjs/index.js",
-      "types": "./es/index.d.ts"
+      "types": "./es/types/index.d.ts"
     },
     "./array": {
       "default": "./es/array/index.js",
       "import": "./es/array/index.js",
       "require": "./cjs/array/index.js",
-      "types": "./es/src/array/index.d.ts"
+      "types": "./es/types/array/index.d.ts"
     },
     "./className": {
       "default": "./es/className.js",
       "import": "./es/className.js",
       "require": "./cjs/className.js",
-      "types": "./es/src/className.d.ts"
+      "types": "./es/types/className.d.ts"
     },
     "./getRandomNumber": {
       "default": "./es/getRandomNumber.js",
       "import": "./es/getRandomNumber.js",
       "require": "./cjs/getRandomNumber.js",
-      "types": "./es/src/getRandomNumber.d.ts"
+      "types": "./es/types/getRandomNumber.d.ts"
     },
     "./getRandomString": {
       "default": "./es/getRandomString.js",
       "import": "./es/getRandomString.js",
       "require": "./cjs/getRandomString.js",
-      "types": "./es/src/getRandomString.d.ts"
-    },
-    "./index": {
-      "default": "./es/index.js",
-      "import": "./es/index.js",
-      "require": "./cjs/index.js",
-      "types": "./es/src/index.d.ts"
+      "types": "./es/types/getRandomString.d.ts"
     },
     "./isNode": {
       "default": "./es/isNode.js",
       "import": "./es/isNode.js",
       "require": "./cjs/isNode.js",
-      "types": "./es/src/isNode.d.ts"
+      "types": "./es/types/isNode.d.ts"
     },
     "./object": {
       "default": "./es/object/index.js",
       "import": "./es/object/index.js",
       "require": "./cjs/object/index.js",
-      "types": "./es/src/object/index.d.ts"
+      "types": "./es/types/object/index.d.ts"
     },
     "./performance": {
       "default": "./es/performance.js",
       "import": "./es/performance.js",
       "require": "./cjs/performance.js",
-      "types": "./es/src/performance.d.ts"
+      "types": "./es/types/performance.d.ts"
     },
     "./regexp": {
       "default": "./es/regexp/index.js",
       "import": "./es/regexp/index.js",
       "require": "./cjs/regexp/index.js",
-      "types": "./es/src/regexp/index.d.ts"
+      "types": "./es/types/regexp/index.d.ts"
     },
     "./sleep": {
       "default": "./es/sleep.js",
       "import": "./es/sleep.js",
       "require": "./cjs/sleep.js",
-      "types": "./es/src/sleep.d.ts"
+      "types": "./es/types/sleep.d.ts"
     }
   },
   "repository": {
@@ -99,11 +93,9 @@
   },
   "keywords": [
     "a-js-tools",
-    "Mr.MudBean",
-    "earthnut",
-    "js tools"
+    "js 工具"
   ],
-  "homepage": "https://earthnut.dev/npm/a-js-tools",
+  "homepage": "https://lmssee.com/npm/a-js-tools",
   "bugs": {
     "url": "https://github.com/MrMudBean/a-js-tools/issues",
     "email": "Mr.MudBean@outlook.com"

package/es/src/regexp/escapeRegExp.d.ts

@@ -1,18 +0,0 @@
-/**
- *
- * 将一个字符串转化为符合正则要求的字符串
- *
- * @param str 需要转义的字符串
- * @requires escapeRegExp 转化后字符串
- * @example
- *
- * ```ts
- *  import { escapeRegExp  } from 'a-js-tools';
- *
- *  escapeRegExp('a.b.c'); // 'a\\.b\\.c'
- *  escapeRegExp('a\\.b\\.c'); // 'a\\\\.b\\\\.c'
- *  escapeRegExp('[a-z]'); // '\\[a-z\\]'
- *  escapeRegExp('^abc$'); // '\\^abc\\$'
- * ```
- */
-export declare function escapeRegExp(str: string): string;