Merge pull request #7 from Collaborne/pr/typings

Provide TypeScript types

Author: disjunction

package.json

@@ -3,6 +3,7 @@
   "version": "2.0.3",
   "description": "extracts and replaces values and IDs in URLs",
   "main": "src/UrlValueParser.js",
+  "types": "url-value-parser.d.ts",
   "scripts": {
     "test": "./node_modules/jasme/run.js"
   },

url-value-parser.d.ts

@@ -0,0 +1,19 @@
+interface Options {
+    /** use custom masks instead of built-in */
+    replaceMasks?: string[]|RegExp[];
+    /** add your custom masks additionally to the built-in ones */
+    extraMasks?: string[]|RegExp[];
+    /* when using built-in masks, count only long enough HEX values, DEFAULT: 7 */
+    minHexLength?: number;
+    /* when using built-in masks, count only long enough base64 values, DEFAULT: 66 */
+    minBase64Length?: number;
+}
+
+declare class UrlValueParser {
+    constructor(options?: Options);
+
+    public parsePathValues(path: string): { chunks: string[], valueIndexes: number[]; }
+    public replacePathValues(path: string, replacement: string): string;
+}
+
+export = UrlValueParser;