foreslash 0.0.1

package/README.md

@@ -0,0 +1,13 @@
+# Foreslash
+
+Foreslash 是一个 javascript 工具库，包含大量函数。
+
+Foreslash is a javascript utilities lib which contains plenty of functions.
+
+## 安装
+
+```bash
+npm install foreslash # 使用 npm 安装
+yarn add foreslash # 使用 yarn 安装
+pnpm install foreslash # 使用 pnpm 安装
+```

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './random/index';
+export * from './utils/index';

package/lib/index.js

@@ -0,0 +1,2 @@
+export * from './random/index';
+export * from './utils/index';

package/lib/random/index.d.ts

@@ -0,0 +1,3 @@
+export * from './randomChoice';
+export * from './randomInt';
+export * from './randomString';

package/lib/random/index.js

@@ -0,0 +1,3 @@
+export * from './randomChoice';
+export * from './randomInt';
+export * from './randomString';

package/lib/random/randomChoice.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 从给定的数组中返回随机一个元素
+ * @param arr 可以是数组或类数组对象
+ * @returns 从数组中随机选择的元素
+ */
+export declare function randomChoice<T>(arr: ArrayLike<T>): T;

package/lib/random/randomChoice.js

@@ -0,0 +1,9 @@
+import { randomIntFloor } from './randomInt';
+/**
+ * 从给定的数组中返回随机一个元素
+ * @param arr 可以是数组或类数组对象
+ * @returns 从数组中随机选择的元素
+ */
+export function randomChoice(arr) {
+    return arr[randomIntFloor(0, arr.length)];
+}

package/lib/random/randomInt.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 生成指定范围内的随机整数
+ * @param min 随机数的下界，包含于此范围内
+ * @param max 随机数的上界，包含于此范围内
+ * @returns 返回一个在`[min, max]`范围内的随机整数
+ */
+export declare function randomInt(min: number, max: number): number;
+/**
+ * 生成指定范围内的随机整数，**不含上界**
+ * @param min 随机数的下界，包含于此范围内
+ * @param max 随机数的上界，**不包含**于此范围内
+ * @returns 返回一个在`[min, max)`范围内的随机整数
+ */
+export declare function randomIntFloor(min: number, max: number): number;

package/lib/random/randomInt.js

@@ -0,0 +1,18 @@
+/**
+ * 生成指定范围内的随机整数
+ * @param min 随机数的下界，包含于此范围内
+ * @param max 随机数的上界，包含于此范围内
+ * @returns 返回一个在`[min, max]`范围内的随机整数
+ */
+export function randomInt(min, max) {
+    return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+/**
+ * 生成指定范围内的随机整数，**不含上界**
+ * @param min 随机数的下界，包含于此范围内
+ * @param max 随机数的上界，**不包含**于此范围内
+ * @returns 返回一个在`[min, max)`范围内的随机整数
+ */
+export function randomIntFloor(min, max) {
+    return Math.floor(Math.random() * (max - min)) + min;
+}

package/lib/random/randomString.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 生成指定长度的随机字符串
+ * @param length 字符串的长度
+ * @param chars 字符集，默认为大小写字母和数字
+ * @returns 生成的随机字符串
+ */
+export declare function randomString(length: number, chars?: string): string;
+/**
+ * 生成指定长度的随机十六进制字符串（小写），`randomString`也能实现此功能但是性能更差
+ * @param length 字符串的长度
+ * @returns 返回一个长度为`length`的随机十六进制字符串
+ */
+export declare function randomHexString(length: number): string;

package/lib/random/randomString.js

@@ -0,0 +1,50 @@
+import { randomChoice } from './randomChoice';
+/**
+ * 生成指定长度的随机字符串
+ * @param length 字符串的长度
+ * @param chars 字符集，默认为大小写字母和数字
+ * @returns 生成的随机字符串
+ */
+export function randomString(length, chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789') {
+    if (!Number.isInteger(length) || length <= 0) {
+        throw new Error('Invalid length parameter');
+    }
+    let res = '';
+    for (let i = 0; i < length; i++)
+        res += randomChoice(chars);
+    return res;
+}
+/**
+ * 生成指定长度的随机十六进制字符串（小写），`randomString`也能实现此功能但是性能更差
+ * @param length 字符串的长度
+ * @returns 返回一个长度为`length`的随机十六进制字符串
+ */
+export function randomHexString(length) {
+    // return randomString(length, '0123456789abcdef')
+    if (!Number.isInteger(length) || length <= 0) {
+        throw new Error('Invalid length parameter');
+    }
+    // length 大于 13 时需要分多次生成，避免超出 Number.MAX_SAFE_INTEGER
+    // 16 ** 13 < Number.MAX_SAFE_INTEGER < 16 ** 14
+    if (length > 13) {
+        const count = Math.floor(length / 13);
+        let res = _randomHexString(length % 13);
+        for (let i = 0; i < count; i++)
+            res += _randomHexString(13);
+        return res;
+    }
+    else {
+        return _randomHexString(length);
+    }
+}
+/**
+ * 内部方法，生成指定长度的随机十六进制字符串
+ * @param length 字符串的长度，不能超过 13
+ * @returns 返回一个长度为`length`的随机十六进制字符串
+ */
+function _randomHexString(length) {
+    let res = Math.floor(Math.random() * 16 ** length).toString(16);
+    while (res.length < length)
+        res = '0' + res;
+    return res;
+}

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './noop';

package/lib/utils/index.js

@@ -0,0 +1 @@
+export * from './noop';

package/lib/utils/noop.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 不做任何操作，返回`void`，一般用于函数式编程
+ */
+declare const noop: (...args: any[]) => void;
+/**
+ * 不做任何操作，返回第一个参数，一般用于函数式编程
+ * @param value 任意值
+ * @returns 传入的第一个值
+ */
+export declare function pass<T>(value: T, ...args: any[]): T;
+export declare function pass<T>(...args: T[]): T;
+export declare function pass(): undefined;
+export { noop };

package/lib/utils/noop.js

@@ -0,0 +1,8 @@
+/**
+ * 不做任何操作，返回`void`，一般用于函数式编程
+ */
+const noop = /*#__PURE__*/ function noop() { };
+export function pass(value) {
+    return value;
+}
+export { noop };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "foreslash",
+  "version": "0.0.1",
+  "description": "Foreslash is a javascript utilities lib which contains plenty of functions.",
+  "main": "lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "test": "jest --coverage"
+  },
+  "keywords": [
+    "foreslash",
+    "lib",
+    "util",
+    "modules"
+  ],
+  "author": "moushu",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Moushudyx/foreslash/issues"
+  },
+  "homepage": "https://github.com/Moushudyx/foreslash#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.5.4",
+    "yarn": "^1.22.22"
+  }
+}