[docs] 完善 random 文档, 其他文档细节修改

packages/mixte/src/is/index.md

@@ -1,6 +1,7 @@
 - 常用的类型判断方法
 - 该页面的方法可以打开浏览器的 JavaScript 控制台, 使用 `Mixte.{fn-name}` 的方式使用
 
+
 ## `isString`
 
 判断传入参数是否是 String 类型
@@ -20,6 +21,7 @@ isString('666'); // -> true
 isString(666); // -> false
 ```
 
+
 ## `isNumber`
 
 判断传入参数是否是 Number 类型, 并且不为 NaN
@@ -40,6 +42,7 @@ isNumber('666'); // -> false
 isNumber(NaN); // -> false
 ```
 
+
 ## `isNumericString`
 
 判断传入参数是否数字字符串
@@ -60,6 +63,7 @@ isNumericString(666); // -> false
 isNumericString(NaN); // -> false
 ```
 
+
 ## `isNumeric`
 
 判断传入参数是否是数字, 支持判断数字字符串
@@ -80,6 +84,7 @@ isNumeric('666'); // -> true
 isNumeric(NaN); // -> false
 ```
 
+
 ## `isObject`
 
 判断传入参数是否是 Object 类型, 并且不为 null
@@ -101,6 +106,7 @@ isObject(() => {}); // -> false
 isObject(666); // -> false
 ```
 
+
 ## `isPlainObject`
 
 判断传入参数是否是纯粹的对象
@@ -121,6 +127,7 @@ isPlainObject(Object.create(null)); // -> true
 isPlainObject([]); // -> false
 ```
 
+
 ## `isFunction`
 
 判断传入参数是否是 Function 类型
@@ -142,6 +149,7 @@ isFunction([]); // -> false
 isFunction(666); // -> false
 ```
 
+
 ## `isNativePromise`
 
 判断传入参数是否是 Promise 对象
@@ -162,6 +170,7 @@ isNativePromise(Promise.resolve()); // -> true
 isNativePromise({ then() {}, catch() {} }); // -> false
 ```
 
+
 ## `isPromise`
 
 判断传入参数是否是 Promise 对象或是类似于 Promise 的对象
@@ -182,6 +191,7 @@ isPromise(Promise.resolve()); // -> true
 isPromise({ then() {}, catch() {} }); // -> true
 ```
 
+
 ## `isReference`
 
 判断传入参数是否是引用类型
@@ -211,6 +221,7 @@ isReference(Symbol('666')); // -> false
 isReference(666n); // -> false
 ```
 
+
 ## `isPrimitive`
 
 判断传入参数是否是原始类型
@@ -240,6 +251,7 @@ isPrimitive([]); // -> false
 isPrimitive(() => {}); // -> false
 ```
 
+
 ## `isEmptyObject`
 
 判断传入对象是否是一个空对象
@@ -259,6 +271,7 @@ isEmptyObject({}); // -> true
 isEmptyObject({ mixte: 6 }); // -> false
 ```
 
+
 ## `isESModule`
 
 判断传入参数是否是 ES Module

packages/mixte/src/random/index.md

@@ -1,12 +1,17 @@
 - 各种随机函数
 
+
 ## `randomNatural`
 
 在传入的两个自然数之间随机生成一个自然数
 
 ### 类型
 
 ```ts
+/**
+ * @param from 最小的自然数
+ * @param to 最大的自然数
+ */
 function randomNatural(from: number, to: number): number;
 ```
 
@@ -18,17 +23,22 @@ import { randomNatural } from 'mixte';
 randomNatural(0, 10); // -> 0 ~ 10
 ```
 
+
 ## `random`
 
 在传入的两个数字之间随机生成一个数字
 
-# 类型
+### 类型
 
 ```ts
+/**
+ * @param from 第一个数字
+ * @param to 第二个数字
+ */
 function random(from: number, to: number): number;
 ```
 
-# 示例
+### 示例
 
 ```ts
 import { random } from 'mixte';
@@ -37,3 +47,122 @@ random(0, 10); // -> 0 ~ 10
 random(10, 0); // -> 0 ~ 10
 random(-10, 10); // -> -10 ~ 10
 ```
+
+
+## `randomLowercaseLetter`
+
+随机一个小写英文字母
+
+### 类型
+
+```ts
+function randomLowercaseLetter(): string;
+```
+
+### 示例
+
+```ts
+import { randomLowercaseLetter } from 'mixte';
+
+randomLowercaseLetter(); // -> a ~ z
+```
+
+
+## `randomUppercaseLetter`
+
+随机一个大写英文字母
+
+### 类型
+
+```ts
+function randomUppercaseLetter(): string;
+```
+
+### 示例
+
+```ts
+import { randomUppercaseLetter } from 'mixte';
+
+randomUppercaseLetter(); // -> A ~ Z
+```
+
+
+## `randomLetter`
+
+随机一个英文字母
+
+### 类型
+
+```ts
+/**
+ * @param uppercase 是否大写 ( default: false )
+ */
+function randomLetter(uppercase?: boolean): string;
+```
+
+### 示例
+
+```ts
+import { randomLetter } from 'mixte';
+
+randomLetter(); // -> a ~ z
+randomLetter(true); // -> A ~ Z
+```
+
+
+## `randomString`
+
+生成一个随机的字符串
+
+### 类型
+
+```ts
+/**
+ * @param length 字符串的长度 ( default: 12 )
+ * @param options 生成字符串的选项
+ */
+function randomString(length?: number, options?: RandomStringOptions): string;
+
+interface RandomStringOptions {
+  /** 是否包含小写字母 ( default: true ) */
+  lowercase?: boolean
+  /** 是否包含大写字母 ( default: false ) */
+  uppercase?: boolean
+  /** 是否包含数字 ( default: false ) */
+  number?: boolean
+}
+```
+
+### 示例
+
+```ts
+import { randomString } from 'mixte';
+
+// -> 默认生成 12 位的仅有小写字母的字符串
+randomString();
+// -> 生成 18 位的包含小写字母和大写字母的字符串
+randomString(18, { uppercase: true });
+// -> 生成 18 位的包含小写字母、大写字母和数字的字符串
+randomString(18, { uppercase: true, number: true });
+// -> 生成 18 位的包含大写字母和数字的字符串
+randomString(18, { uppercase: true, number: true, lowercase: false });
+```
+
+
+## `randomBoolean`
+
+生成一个随机的 boolean 值
+
+### 类型
+
+```ts
+function randomBoolean(): boolean;
+```
+
+### 示例
+
+```ts
+import { randomBoolean } from 'mixte';
+
+randomBoolean(); // -> true or false
+```

packages/use/src/useCountdown/index.md

@@ -1,5 +1,6 @@
 - 创建一个倒计时
 
+
 ## 用法
 
 ```html