util-helpers
Version:
36 lines (35 loc) • 1.16 kB
TypeScript
declare const chars: {
number: string;
lower: string;
upper: string;
};
interface RandomString {
<T extends keyof typeof chars>(len: number, poll: T): string;
(len: number, poll?: string): string;
<T extends keyof typeof chars>(len: number, poll: Array<T>): string;
}
/**
* 生成随机字符串
*
* @function
* @alias module:Other.randomString
* @since 4.8.0
* @param {number} [len=0] 长度,默认`0`
* @param {'number' | 'lower' | 'upper' | string | Array<'number' | 'lower' | 'upper'>} [pool='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 字符池,默认为数字和大小写字母。支持设置类型`number` `lower` `upper` 或字符串,也支持数组组合。
* @returns {string} 随机字符串
* @example
*
* randomString(5); // slk23
* randomString(8); // 71mHqo2A
*
* // 自定义允许的字符
* randomString(5, 'abc'); // ccbcb
* randomString(8, 'abcefg'); // bcgcfabg
*
* // 使用数组组合
* randomString(5, ['number', 'lower']); // 1a2b3
* randomString(8, ['upper', 'number']); // A1B2C3D4
*
*/
declare const randomString: RandomString;
export default randomString;