path-pattern - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "path-pattern",
-  "version": "0.1.0",
-  "description": "A url matching lib to go with Realytivs/react-router-magic",
+  "version": "0.1.1",
+  "description": "A url matching lib to go with Realytics/react-router-magic",
   "author": "Etienne Dldc <[e-mail]>",
@@ -6,0 +6,0 @@ "license": "MIT",

README.md

@@ -1,2 +0,119 @@
-# path-pattern
-A small library to match and compile paths
+# Path Pattern
+> A small library to match and compile paths
+
+This is a a wrapper aroud [path-to-regexp](https://github.com/pillarjs/path-to-regexp).
+
+## This package is not Production ready !
+
+This package is under developement, do not use it in production. 
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+You need [NodeJS](https://nodejs.org/en/) and [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/en/).
+
+### Installing
+
+```bash
+npm install path-pattern --save
+```
+
+or
+
+```bash
+yarn add path-pattern
+```
+
+## Import in your project
+
+### Node
+
+```js
+const PathPattern = require('path-pattern').PathPattern;
+```
+
+### ES6 or Typescript
+
+> Note : If you use Typescript, typings are include in the package !
+
+```js
+import { PathPattern } fropm 'path-pattern';
+```
+
+##Usage
+
+```js
+const homePattern = new PathPattern('/home');
+// same as
+const homePattern = new PathPattern('/home', { exact: false, strict: false });
+```
+
+## API
+
+### `PathPattern`
+
+#### `new PathPattern<P>(path: string, options?: { strict?: boolean, exact?: boolean })`
+
+- `P`: Type of params object (in Match resulr)
+- `path`: The path pattern to parse, see [path-to-regexp docs](https://github.com/pillarjs/path-to-regexp)
+- `option.strict`: (`false` by default) When `true`, a path that has a trailing slash will only match a location.pathname with a trailing slash. This has no effect when there are additional URL segments in the location.pathname
+- `option.exact`: (`false` by default) When `true`, the path will not match sub path (see table below)
+
+##### Examples
+
+- `new PathPattern('/home')` (any path that start with home)
+  - Will match
+    - `/home`
+    - `/home/`
+    - `/home/user`
+    - `/home/user/`
+    - `/home/user/john`
+  - Will not match
+    - `/`
+    - `/welcome`
+- `new PathPattern('/home', { exact: true })` (home path)
+  - Will match
+    - `/home`
+    - `/home/`
+  - Will not match
+    - `/home/user`
+    - `/home/user/`
+    - `/home/user/john`
+    - `/`
+    - `/welcome`
+- `new PathPattern('/home/', { exact: true, strict: true })` (home path with a trailing slash)
+  - Will match
+    - `/home/`
+  - Will not match
+    - `/home`
+    - `/home/user`
+    - `/home/user/`
+    - `/home/user/john`
+    - `/`
+    - `/welcome`
+
+#### `match(location: string): (Match<P> | false)`
+
+- `location`: the `location.pathname` you want to match
+- Result : a `Match` object is the location match the path, false if not. See Match object bellow
+
+#### `compile(params: P): string`
+
+#### `Match`
+
+Match is a plain object that contain the following keys:   
+- `path: string`: The path that match, example: `/user/:user`
+- `url: string`: The url that match, example: `/user/john`,
+- `isExact: boolean`: Is the match an exact match example: `false`,
+- `params: {[paramName: string]: any}`: Params found, example: `{ 'user': 'john' }`
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/Realytics/path-pattern/releases). 
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79536

increased by4.26%

Number of lines in readme file

119

increased by3866.67%

No dependency changes