fix(fast-path-parse): declaration types added

dalisoft · Sep 3, 2024 · b908746 · b908746
1 parent cbab236
commit b908746
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 14 deletions.
diff --git a/packages/fast-path-parse/aot/match.d.ts b/packages/fast-path-parse/aot/match.d.ts
@@ -0,0 +1,5 @@
+function match(
+  path: string
+): (pathname: string, params?: Record<string, string>) => boolean;
+
+export = match;
diff --git a/packages/fast-path-parse/aot/match.js b/packages/fast-path-parse/aot/match.js
@@ -2,8 +2,9 @@ const segmentsSlice = require('../utils/segment.js');
 
 /**
  * Compiles an route path for fastest validation
- * @param {string} path A path to be compiled
- * @returns {(pathname: string, params?: Record<string, string>) => boolean} Optimized function which validate params at runtime
+ * @type {import('./match')}
+ * @param path A path to be compiled
+ * @returns Optimized function which validate params at runtime
  * @example
  * ```ts
  * import compile from 'fast-path-parser/aot/match';

diff --git a/packages/fast-path-parse/aot/parse.d.ts b/packages/fast-path-parse/aot/parse.d.ts
@@ -0,0 +1,8 @@
+function parse(
+  path: string
+): (
+  pathname: string,
+  params?: Record<string, string>
+) => Record<string, string>;
+
+export = parse;
diff --git a/packages/fast-path-parse/aot/parse.js b/packages/fast-path-parse/aot/parse.js
@@ -2,8 +2,9 @@ const segmentsSlice = require('../utils/segment.js');
 
 /**
  * Compiles an route path for fastest parsing
- * @param {string} path A path to be compiled
- * @returns {(pathname: string, params?: Record<string, string>) => params} Optimized function which parse params at runtime
+ * @type {import('./parse')}
+ * @param path A path to be compiled
+ * @returns Optimized function which parse params at runtime
  * @example
  * ```ts
  * import compile from 'fast-path-parser/aot/parse';
@@ -12,7 +13,7 @@ const segmentsSlice = require('../utils/segment.js');
  * pathParse('/user/123') // returns { id: '123' }
  * ```
  */
-const compile = (path) => {
+const parse = (path) => {
   const { segments, filled } = segmentsSlice(path);
 
   if (filled.length > 0) {
@@ -57,4 +58,4 @@ const compile = (path) => {
   return (_, params = {}) => params;
 };
 
-module.exports = compile;
+module.exports = parse;
diff --git a/packages/fast-path-parse/package.json b/packages/fast-path-parse/package.json
@@ -4,10 +4,22 @@
   "description": "Fastest route path-to-params parser",
   "type": "commonjs",
   "exports": {
-    "./aot/parse": "./aot/parse.js",
-    "./aot/match": "./aot/match.js",
-    "./runtime/parse": "./runtime/parse.js",
-    "./runtime/match": "./runtime/match.js"
+    "./aot/parse": {
+      "default": "./aot/parse.js",
+      "types": "./aot/parse.d.ts"
+    },
+    "./aot/match": {
+      "default": "./aot/match.js",
+      "types": "./aot/match.d.ts"
+    },
+    "./runtime/parse": {
+      "default": "./runtime/parse.js",
+      "types": "./runtime/parse.d.ts"
+    },
+    "./runtime/match": {
+      "default": "./runtime/match.js",
+      "types": "./runtime/match.d.ts"
+    }
   },
   "files": [
     "aot",

diff --git a/packages/fast-path-parse/runtime/match.d.ts b/packages/fast-path-parse/runtime/match.d.ts
@@ -0,0 +1,5 @@
+function match(
+  path: string
+): (pathname: string, params?: Record<string, string>) => boolean;
+
+export = match;
diff --git a/packages/fast-path-parse/runtime/match.js b/packages/fast-path-parse/runtime/match.js
@@ -2,8 +2,9 @@ const segmentsSlice = require('../utils/segment.js');
 
 /**
  * Prepares an route path for validating
- * @param {string} path A path to be compiled
- * @returns {(pathname: string, params?: Record<string, string>) => boolean} Function which validates runtime
+ * @type {import('./match')}
+ * @param path A path to be compiled
+ * @returns Function which validates runtime
  * @example
  * ```ts
  * import match from 'fast-path-parser/runtime/match';

diff --git a/packages/fast-path-parse/runtime/parse.d.ts b/packages/fast-path-parse/runtime/parse.d.ts
@@ -0,0 +1,8 @@
+function parse(
+  path: string
+): (
+  pathname: string,
+  params?: Record<string, string>
+) => Record<string, string>;
+
+export = parse;
diff --git a/packages/fast-path-parse/runtime/parse.js b/packages/fast-path-parse/runtime/parse.js
@@ -2,8 +2,9 @@ const segmentsSlice = require('../utils/segment.js');
 
 /**
  * Prepares an route path for parsing
- * @param {string} path A path to be compiled
- * @returns {(pathname: string, params?: Record<string, string>) => params} Function which parse params at runtime
+ * @type {import('./parse')}
+ * @param path A path to be compiled
+ * @returns Function which parse params at runtime
  * @example
  * ```ts
  * import parse from 'fast-path-parser/runtime/parse';