multi-path-matcher
Advanced tools
Comparing version 2.3.3 to 3.0.0
{ | ||
"name": "multi-path-matcher", | ||
"version": "2.3.3", | ||
"version": "3.0.0", | ||
"publishConfig": { | ||
@@ -24,5 +24,5 @@ "access": "public" | ||
"test": "npm run test:browser-ava && npm run test:ava", | ||
"test:ava": "ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs", | ||
"test:ava": "ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs && ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs", | ||
"test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs", | ||
"cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp", | ||
"cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp", | ||
"docs": "documentation readme --section=API ./src/**/*.mjs", | ||
@@ -33,10 +33,10 @@ "lint": "npm run lint:docs", | ||
"devDependencies": { | ||
"ava": "^5.2.0", | ||
"browser-ava": "^1.3.39", | ||
"c8": "^7.13.0", | ||
"documentation": "^14.0.1", | ||
"semantic-release": "^21.0.2" | ||
"ava": "^5.3.1", | ||
"browser-ava": "^1.4.0", | ||
"c8": "^8.0.1", | ||
"documentation": "^14.0.2", | ||
"semantic-release": "^22.0.5" | ||
}, | ||
"engines": { | ||
"node": ">=16.20.0" | ||
"node": ">=18.18.2" | ||
}, | ||
@@ -43,0 +43,0 @@ "repository": { |
@@ -67,3 +67,3 @@ [![npm](https://img.shields.io/npm/v/multi-path-matcher.svg)](https://www.npmjs.com/package/multi-path-matcher) | ||
* [CompiledRoutes](#compiledroutes) | ||
* [CompiledRoute](#compiledroute) | ||
* [Properties](#properties) | ||
@@ -79,4 +79,2 @@ * [Route](#route) | ||
* [Parameters](#parameters) | ||
* [CompiledRoute](#compiledroute) | ||
* [Properties](#properties-3) | ||
* [pathToRegexp](#pathtoregexp) | ||
@@ -87,6 +85,11 @@ * [Parameters](#parameters-1) | ||
## CompiledRoutes | ||
## CompiledRoute | ||
Result of the routes compilation | ||
Result of a path compilation | ||
priorities for each path component | ||
* :param [PARAM](#param) | ||
* match \* or ? [MATCH](#match) | ||
* plain [PLAIN](#plain) | ||
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | ||
@@ -97,5 +100,5 @@ | ||
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  | ||
* `priority` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** higher number reflect more precise matches | ||
* `keys` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** parameter names extractable from route | ||
* `regex` **[RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)**  | ||
* `regex` **[RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** for later checking and params extraction | ||
* `keys` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** all keys found in the route | ||
* `priority` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** order in which to check | ||
@@ -120,3 +123,3 @@ ## Route | ||
* `route` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Route](#route)>** as given to the compiler, undefined if no matching route was found | ||
* `route` **[Route](#route)?** as given to the compiler, undefined if no matching route was found | ||
* `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** extracted from the path | ||
@@ -151,21 +154,4 @@ | ||
Returns **[CompiledRoutes](#compiledroutes)**  | ||
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CompiledRoute](#compiledroute)>**  | ||
## CompiledRoute | ||
Result of a path compilation | ||
priorities for each path component | ||
* :param [PARAM](#param) | ||
* match \* or ? [MATCH](#match) | ||
* plain [PLAIN](#plain) | ||
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | ||
### Properties | ||
* `regex` **[RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** for later checking and params extraction | ||
* `keys` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all keys found in the route | ||
* `priority` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** order in which to check | ||
## pathToRegexp | ||
@@ -177,3 +163,3 @@ | ||
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  | ||
* `route` **[Route](#route)**  | ||
@@ -188,3 +174,3 @@ Returns **[CompiledRoute](#compiledroute)**  | ||
* `compiled` **[CompiledRoutes](#compiledroutes)**  | ||
* `compiled` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[CompiledRoute](#compiledroute)>**  | ||
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  | ||
@@ -191,0 +177,0 @@ |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
11347
183