twitst4tz

twitter statistics web application
Log | Files | Refs | README | LICENSE

Readme.md (1102B)


      1 # Path-to-RegExp
      2 
      3 Turn an Express-style path string such as `/user/:name` into a regular expression.
      4 
      5 **Note:** This is a legacy branch. You should upgrade to `1.x`.
      6 
      7 ## Usage
      8 
      9 ```javascript
     10 var pathToRegexp = require('path-to-regexp');
     11 ```
     12 
     13 ### pathToRegexp(path, keys, options)
     14 
     15  - **path** A string in the express format, an array of such strings, or a regular expression
     16  - **keys** An array to be populated with the keys present in the url.  Once the function completes, this will be an array of strings.
     17  - **options**
     18    - **options.sensitive** Defaults to false, set this to true to make routes case sensitive
     19    - **options.strict** Defaults to false, set this to true to make the trailing slash matter.
     20    - **options.end** Defaults to true, set this to false to only match the prefix of the URL.
     21 
     22 ```javascript
     23 var keys = [];
     24 var exp = pathToRegexp('/foo/:bar', keys);
     25 //keys = ['bar']
     26 //exp = /^\/foo\/(?:([^\/]+?))\/?$/i
     27 ```
     28 
     29 ## Live Demo
     30 
     31 You can see a live demo of this library in use at [express-route-tester](http://forbeslindesay.github.com/express-route-tester/).
     32 
     33 ## License
     34 
     35   MIT