fix(fast-path-parse): docs about perf and supported paths

dalisoft · Sep 1, 2024 · ce7f11e · ce7f11e
1 parent e87664b
commit ce7f11e
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/packages/fast-path-parse/README.md b/packages/fast-path-parse/README.md
@@ -42,6 +42,33 @@ const parsePath = parse('/user/:foo');
 parsePath('/user/john');
 ```
 
+## Supported paths
+
+### Information about badges
+
+- ✅ – Done
+- ✍️ – In progress
+- 🕖 – Planned but not started yet
+- ⚠️ – Requires high amount of time
+- ？– Not tested but could work
+- ❌ – Probably does not happen
+
+| Name                 | Status | Priority | Performance |
+| -------------------- | ------ | -------- | ----------- |
+| `/foo`               | ✅     | 0        | 100%        |
+| `/foo/bar`           | ✅     | 0        | 100%        |
+| `/foo/bar-{one,two}` | ⚠️     | 1        | 60%         |
+| `/foo/bar-[one,two]` | ⚠️     | 1        | 60%         |
+| `/foo/bar_*`         | ⚠️     | 2        | 80%         |
+| `/foo/bar-*`         | ⚠️     | 2        | 80%         |
+| `/foo/bar*`          | ⚠️     | 2        | 80%         |
+| `/foo/bar/<id>`      | 🕖     | 3        | 90%         |
+| `/foo/task/:bar`     | ✅     | 4        | 80%         |
+| `/foo/:task/:bar`    | ✅     | 4        | 70%         |
+| `/foo/:bar`          | ✅     | 5        | 90%         |
+| `/foo/*`             | ✅     | 6        | 90%         |
+| `/foo/(.*)`          | ✅     | 6        | 90%         |
+
 ## License
 
 MIT