fix(fast-path-parse): typings, jsdoc and other typings fixes

packages/fast-path-parse/aot/match.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Compiles an route path for fastest validation
+ * @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';
+ *
+ * const pathMatch = compile('/user/:id');
+ * pathMatch('/user/123') // returns `true`
+ * ```
+ */
 function match(path: string): (pathname: string) => boolean;
 
 export = match;

packages/fast-path-parse/aot/match.js

@@ -1,17 +1,7 @@
 const segmentsSlice = require('../utils/segment.js');
 
 /**
- * Compiles an route path for fastest validation
  * @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';
- *
- * const pathMatch = compile('/user/:id');
- * pathMatch('/user/123') // returns `true`
- * ```
  */
 // eslint-disable-next-line max-lines-per-function
 const match = (path) => {

packages/fast-path-parse/aot/parse.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Compiles an route path for fastest parsing
+ * @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';
+ *
+ * const pathParse = compile('/user/:id');
+ * pathParse('/user/123') // returns { id: '123' }
+ * ```
+ */
 function parse(
   path: string
 ): (

packages/fast-path-parse/aot/parse.js

@@ -1,17 +1,7 @@
 const segmentsSlice = require('../utils/segment.js');
 
 /**
- * Compiles an route path for fastest parsing
  * @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';
- *
- * const pathParse = compile('/user/:id');
- * pathParse('/user/123') // returns { id: '123' }
- * ```
  */
 const parse = (path) => {
   const { segments, filled } = segmentsSlice(path);

packages/fast-path-parse/runtime/match.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Prepares an route path for validating
+ * @param path A path to be compiled
+ * @returns Function which validates runtime
+ * @example
+ * ```ts
+ * import match from 'fast-path-parser/runtime/match';
+ *
+ * const pathMatch = match('/user/:id');
+ * pathMatch('/user/123') // returns `true`
+ * ```
+ */
 function match(path: string): (pathname: string) => boolean;
 
 export = match;

packages/fast-path-parse/runtime/match.js

@@ -1,19 +1,8 @@
 const segmentsSlice = require('../utils/segment.js');
 
 /**
- * Prepares an route path for validating
  * @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';
- *
- * const pathMatch = match('/user/:id');
- * pathMatch('/user/123') // returns `true`
- * ```
  */
-
 const match = (path) => {
   const { segments, filled, length: LENGTH } = segmentsSlice(path);
 

packages/fast-path-parse/runtime/parse.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Prepares an route path for parsing
+ * @param path A path to be compiled
+ * @returns Function which parse params at runtime
+ * @example
+ * ```ts
+ * import parse from 'fast-path-parser/runtime/parse';
+ *
+ * const pathParse = parse('/user/:id');
+ * pathParse('/user/123') // returns { id: '123' }
+ * ```
+ */
 function parse(
   path: string
 ): (

packages/fast-path-parse/runtime/parse.js

@@ -1,19 +1,7 @@
 const segmentsSlice = require('../utils/segment.js');
-
 /**
- * Prepares an route path for parsing
  * @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';
- *
- * const pathParse = parse('/user/:id');
- * pathParse('/user/123') // returns { id: '123' }
- * ```
  */
-
 const parse = (path) => {
   const { segments, filled } = segmentsSlice(path);
 

packages/fast-path-parse/utils/segment.d.ts

@@ -12,6 +12,15 @@ export interface ISegmentSlice {
   length: number;
 }
 
+/**
+ * Parses route string into segments and parses it
+ * @param path A path to parse
+ * @example
+ * ```ts
+ * segmentsSlice('/foo/bar').segments
+ * // [{name: 'foo', segment: false, size: 3, last: false}, {name: 'bar', segment: false, size: 3, last: true}]
+ * ```
+ */
 function segmentsSlice(path: string): ISegmentSlice;
 
 export = segmentsSlice;

packages/fast-path-parse/utils/segment.js

@@ -41,14 +41,7 @@ const parseSegment = (name, getIndex, position = 1) => {
 };
 
 /**
- * Parses route string into segments and parses it
  * @type {import('./segment')}
- * @param path A path to parse
- * @example
- * ```ts
- * segmentsSlice('/foo/bar').segments
- * // [{name: 'foo', segment: false, size: 3, last: false}, {name: 'bar', segment: false, size: 3, last: true}]
- * ```
  */
 module.exports = function segmentsSlice(path) {
   let INDEX = 1;