Allow plain objects for TokenData (#391)

Author: blakeembrey

Readme.md

@@ -66,7 +66,7 @@ fn("/users/123/delete");
 
 The `match` function returns a function for matching strings against a path:
 
-- **path** String or array of strings.
+- **path** String, `TokenData` object, or array of strings and `TokenData` objects.
 - **options** _(optional)_ (Extends [pathToRegexp](#pathToRegexp) options)
   - **decode** Function for decoding strings to params, or `false` to disable all processing. (default: `decodeURIComponent`)
 
@@ -80,7 +80,7 @@ const fn = match("/foo/:bar");
 
 The `pathToRegexp` function returns the `regexp` for matching strings against paths, and an array of `keys` for understanding the `RegExp#exec` matches.
 
-- **path** String or array of strings.
+- **path** String, `TokenData` object, or array of strings and `TokenData` objects.
 - **options** _(optional)_ (See [parse](#parse) for more options)
   - **sensitive** Regexp will be case sensitive. (default: `false`)
   - **end** Validate the match reaches the end of the string. (default: `true`)
@@ -97,7 +97,7 @@ regexp.exec("/foo/123"); //=> ["/foo/123", "123"]
 
 The `compile` function will return a function for transforming parameters into a valid path:
 
-- **path** A string.
+- **path** A string or `TokenData` object.
 - **options** (See [parse](#parse) for more options)
   - **delimiter** The default delimiter for segments, e.g. `[^/]` for `:named` parameters. (default: `'/'`)
   - **encode** Function for encoding input strings for output into the path, or `false` to disable entirely. (default: `encodeURIComponent`)
@@ -121,15 +121,17 @@ toPathRaw({ id: "%3A%2F" }); //=> "/user/%3A%2F"
 
 ## Stringify
 
-Transform `TokenData` (a sequence of tokens) back into a Path-to-RegExp string.
+Transform a `TokenData` object to a Path-to-RegExp string.
 
-- **data** A `TokenData` instance
+- **data** A `TokenData` object.
 
 ```js
-const data = new TokenData([
-  { type: "text", value: "/" },
-  { type: "param", name: "foo" },
-]);
+const data = {
+  tokens: [
+    { type: "text", value: "/" },
+    { type: "param", name: "foo" },
+  ],
+};
 
 const path = stringify(data); //=> "/:foo"
 ```
@@ -149,20 +151,24 @@ The `parse` function accepts a string and returns `TokenData`, which can be used
 
 ### Tokens
 
-`TokenData` is a sequence of tokens, currently of types `text`, `parameter`, `wildcard`, or `group`.
+`TokenData` has two properties:
+
+- **tokens** A sequence of tokens, currently of types `text`, `parameter`, `wildcard`, or `group`.
+- **originalPath** The original path used with `parse`, shown in error messages to assist debugging.
 
 ### Custom path
 
-In some applications, you may not be able to use the `path-to-regexp` syntax, but still want to use this library for `match` and `compile`. For example:
+In some applications you may not be able to use the `path-to-regexp` syntax, but you still want to use this library for `match` and `compile`. For example:
 
 ```js
-import { TokenData, match } from "path-to-regexp";
+import { match } from "path-to-regexp";
 
 const tokens = [
   { type: "text", value: "/" },
   { type: "parameter", name: "foo" },
 ];
-const path = new TokenData(tokens);
+const originalPath = "/[foo]"; // To help debug error messages.
+const path = { tokens, originalPath };
 const fn = match(path);
 
 fn("/test"); //=> { path: '/test', index: 0, params: { foo: 'test' } }

src/cases.spec.ts

@@ -221,6 +221,16 @@ export const STRINGIFY_TESTS: StringifyTestSet[] = [
     ]),
     expected: "\\\\:test",
   },
+  {
+    data: {
+      tokens: [
+        { type: "text", value: "/" },
+        { type: "param", name: "test" },
+      ],
+      originalPath: "/:test",
+    },
+    expected: "/:test",
+  },
 ];
 
 export const COMPILE_TESTS: CompileTestSet[] = [
@@ -323,6 +333,15 @@ export const COMPILE_TESTS: CompileTestSet[] = [
       { input: { test: "123/xyz" }, expected: "/123/xyz" },
     ],
   },
+  {
+    path: {
+      tokens: [
+        { type: "text", value: "/" },
+        { type: "param", name: "test" },
+      ],
+    },
+    tests: [{ input: { test: "123" }, expected: "/123" }],
+  },
 ];
 
 /**
@@ -1678,4 +1697,19 @@ export const MATCH_TESTS: MatchTestSet[] = [
       },
     ],
   },
+
+  /**
+   * Token data.
+   */
+  {
+    path: {
+      tokens: [
+        { type: "text", value: "/" },
+        { type: "param", name: "test" },
+      ],
+    },
+    tests: [
+      { input: "/123", expected: { path: "/123", params: { test: "123" } } },
+    ],
+  },
 ];

src/index.ts

@@ -334,7 +334,7 @@ export function compile<P extends ParamData = ParamData>(
 ) {
   const { encode = encodeURIComponent, delimiter = DEFAULT_DELIMITER } =
     options;
-  const data = path instanceof TokenData ? path : parse(path, options);
+  const data = typeof path === "object" ? path : parse(path, options);
   const fn = tokensToFunction(data.tokens, delimiter, encode);
 
   return function path(params: P = {} as P) {
@@ -504,7 +504,7 @@ export function pathToRegexp(
   const sources: string[] = [];
 
   for (const input of pathsToArray(path, [])) {
-    const data = input instanceof TokenData ? input : parse(input, options);
+    const data = typeof input === "object" ? input : parse(input, options);
     for (const tokens of flatten(data.tokens, 0, [])) {
       sources.push(toRegExp(tokens, delimiter, keys, data.originalPath));
     }