fix(fast-path-parse): add utils for export

dalisoft · Sep 15, 2024 · 9677d6e · 9677d6e
1 parent c49f254
commit 9677d6e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/packages/fast-path-parse/package.json b/packages/fast-path-parse/package.json
@@ -19,6 +19,10 @@
     "./runtime/match": {
       "default": "./runtime/match.js",
       "types": "./runtime/match.d.ts"
+    },
+    "./utils/segment": {
+      "default": "./utils/segment.js",
+      "types": "./utils/segment.d.ts"
     }
   },
   "files": [

diff --git a/packages/fast-path-parse/utils/segment.d.ts b/packages/fast-path-parse/utils/segment.d.ts
@@ -0,0 +1,16 @@
+export interface ISegment {
+  name: string;
+  segment: boolean;
+  position: number;
+  last: boolean;
+}
+
+export interface ISegmentSlice {
+  segments: ISegment[];
+  filled: ISegment[];
+  length: number;
+}
+
+function segmentsSlice(path: string): ISegmentSlice;
+
+export = segmentsSlice;
diff --git a/packages/fast-path-parse/utils/segment.js b/packages/fast-path-parse/utils/segment.js
@@ -4,6 +4,7 @@
  * @param {(() => number)} getIndex
  * @param {number} position
  */
+
 // eslint-disable-next-line complexity
 const parseSegment = (name, getIndex, position = 1) => {
   if (name === '*' || name === '(.*)') {
@@ -25,7 +26,8 @@ const parseSegment = (name, getIndex, position = 1) => {
 
 /**
  * Parses route string into segments and parses it
- * @param {string} path
+ * @type {import('./segment')}
+ * @param path A path to parse
  * @example
  * ```ts
  * segmentsSlice('/foo/bar').segments
@@ -36,7 +38,7 @@ module.exports = function segmentsSlice(path) {
   let INDEX = 1;
 
   /**
-   * @type {Array<{name: string; segment: boolean, last: boolean, position: number}>}
+   * @type {import('./segment').ISegment[]}
    */
   const segments = path
     .substring(1)