randexp.js 技术文档

1. 安装指南

Node.js 安装

在 Node.js 环境中，可以通过 npm 安装 randexp.js：

npm install randexp

浏览器安装

在浏览器中使用时，可以从最新版本的发布页面下载 minified 版本。

2. 项目使用说明

randexp.js 是一个用于生成与给定正则表达式匹配的随机字符串的 JavaScript 库。它支持复杂的正则表达式语法，包括分组、管道、字符集、范围、引用等。

基本用法

const RandExp = require('randexp');

// 生成与正则表达式匹配的随机字符串
new RandExp(/hello+ (world|to you)/).gen();
// 示例输出: hellooooooooooooooooooo world

// 支持字符集和范围
new RandExp(/<([a-z]\w{0,20})>foo<\1>/).gen();
// 示例输出: <m5xhdg>foo<m5xhdg>

// 通配符
new RandExp(/random stuff: .+/).gen();
// 示例输出: random stuff: l3m;Hf9XYbI [YPaxV>U*4-_F!WXQh9>;rH3i l!8.zoh?[utt1OWFQrE ^~8zEQm]~tK

// 忽略大小写
new RandExp(/xxx xtreme dragon warrior xxx/i).gen();
// 示例输出: xxx xtReME dRAGON warRiOR xXX

动态正则表达式快捷方式

const randexp = require('randexp').randexp;

randexp(/[1-6]/); // 示例输出: 4
randexp('great|good( job)?|excellent'); // 示例输出: great

旧语法支持

如果你喜欢旧的语法，可以通过以下方式启用：

require('randexp').sugar();

/yes|no|maybe|i don't know/.gen(); // 示例输出: maybe

3. 项目 API 使用文档

RandExp 类

RandExp 类是 randexp.js 的核心类，用于生成与正则表达式匹配的随机字符串。

构造函数

new RandExp(regexp);

• regexp: 一个正则表达式对象或字符串。

gen() 方法

randexp.gen();

生成与正则表达式匹配的随机字符串。

randexp 快捷方式

const randexp = require('randexp').randexp;

randexp(regexp);

• regexp: 一个正则表达式对象或字符串。

sugar() 方法

require('randexp').sugar();

启用旧语法支持，使得正则表达式对象可以直接调用 .gen() 方法。

默认字符范围

randexp.js 默认生成包含可打印 ASCII 字符的字符串。可以通过 defaultRange 属性自定义字符范围。

const randexp = new RandExp(/random stuff: .+/);
randexp.defaultRange.subtract(32, 126);
randexp.defaultRange.add(0, 65535);
randexp.gen();
// 示例输出: random stuff: 湐箻ໜ䫴␩⶛㳸長���邓蕲뤀쑡篷皇硬剈궦佔칗븛뀃匫鴔事좍ﯣ⭼ꝏ䭍詳蒂䥂뽭

自定义随机数生成器

默认情况下，randexp.js 使用 Math.random() 生成随机数。如果需要使用可种子化的或加密的随机数生成器，可以覆盖 RandExp.prototype.randInt 或 randexp.randInt。

RandExp.prototype.randInt = function(from, to) {
  // 自定义随机数生成逻辑
};

无限重复标记

对于 *, +, {3,} 等无限重复标记，randexp.js 默认在最小值的基础上加 100 作为最大值。可以通过 max 属性自定义最大值。

const randexp = new RandExp(/no{1,}/);
randexp.max = 1000000;

4. 项目安装方式

Node.js

通过 npm 安装：

npm install randexp

浏览器

从最新版本的发布页面下载 minified 版本。

5. 测试

randexp.js 使用 mocha 进行测试。可以通过以下命令运行测试：

npm test

6. TypeScript 支持

randexp.js 包含 TypeScript 定义文件，可以直接在 TypeScript 项目中使用。

import RandExp from "randexp";
const randexp = new RandExp(/[a-z]{6}/);
randexp.gen();

可以使用 dtslint 检查定义文件：

npm install -g dtslint
npm run dtslint