regexparam 项目教程

regexparam 项目教程

regexparamA tiny (394B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️项目地址:https://gitcode.com/gh_mirrors/re/regexparam

1. 项目的目录结构及介绍

regexparam/
├── src/
│   ├── index.js
│   └── index.d.ts
├── test/
│   └── index.js
├── .editorconfig
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── dist/
    ├── index.js
    ├── index.mjs
    └── index.min.js

• src/: 包含项目的源代码文件。
  • index.js: 主逻辑文件。
  • index.d.ts: TypeScript 类型定义文件。
• test/: 包含测试文件。
  • index.js: 测试脚本。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• package.json: 项目配置文件。
• README.md: 项目说明文档。
• dist/: 包含构建后的文件。
  • index.js: CommonJS 模块。
  • index.mjs: ESModule 模块。
  • index.min.js: UMD 模块。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.js。这个文件包含了 regexparam 的核心逻辑，用于将路由模式转换为正则表达式。

// src/index.js
import regexparam from 'https://esm.sh/regexparam';

// 示例用法
const { keys, pattern } = regexparam('/users/:id(\\d+)', true);
const match = pattern.exec('/users/123');
console.log(match); // 输出：['/users/123', '123']

3. 项目的配置文件介绍

项目的配置文件是 package.json，它包含了项目的基本信息、依赖、脚本等。

{
  "name": "regexparam",
  "version": "3.0.0",
  "description": "A tiny (394B) utility that converts route patterns into RegExp",
  "main": "dist/index.js",
  "module": "dist/index.mjs",
  "types": "src/index.d.ts",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "router",
    "regex",
    "regexp",
    "path-to-regexp"
  ],
  "author": "Luke Edwards",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/lukeed/regexparam.git"
  },
  "bugs": {
    "url": "https://github.com/lukeed/regexparam/issues"
  },
  "homepage": "https://github.com/lukeed/regexparam#readme"
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件。
• module: ESModule 入口文件。
• types: TypeScript 类型定义文件。
• scripts: 脚本命令。
• keywords: 项目关键词。
• author: 作者信息。
• license: 许可证。
• repository: 仓库信息。
• bugs: 问题追踪链接。
• homepage: 项目主页。

regexparamA tiny (394B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️项目地址:https://gitcode.com/gh_mirrors/re/regexparam