Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Route metadata #147

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ result = router.recognize("/pages/hello/world");
result === [{ handler: page, params: { path: "hello/world" } }];
```

Metadata:

```javascript
router.add([{ path: "/post/1", handler: page, metadata: { test: 123 } }]);

result = router.recognize("/post/1");
result === [{ handler: page, params: {}, metadata: { test: 123 } }];
```

# Sorting

If multiple routes all match a path, `route-recognizer`
Expand Down
6 changes: 6 additions & 0 deletions lib/route-recognizer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,14 @@ interface EmptyHandler {
handler: Opaque;
names: EmptyArray;
shouldDecodes: EmptyArray;
metadata: Opaque;
}

interface PopulatedHandler {
handler: Opaque;
names: string [];
shouldDecodes: boolean[];
metadata: Opaque;
}

type Handler = EmptyHandler | PopulatedHandler;
Expand Down Expand Up @@ -385,6 +387,7 @@ export interface Result {
handler: Opaque;
params: Params;
isDynamic: boolean;
metadata: Opaque;
}

export interface Results extends ArrayLike<Result | undefined> {
Expand Down Expand Up @@ -449,6 +452,7 @@ function findHandler(state: State, originalPath: string, queryParams: QueryParam

result[i] = {
handler: handler.handler,
metadata: handler.metadata,
params,
isDynamic
};
Expand Down Expand Up @@ -526,8 +530,10 @@ class RouteRecognizer {
currentState = eachChar[segment.type](segment, currentState);
pattern += regex[segment.type](segment);
}

handlers[i] = {
handler: route.handler,
metadata: route.metadata,
names,
shouldDecodes
};
Expand Down
7 changes: 4 additions & 3 deletions lib/route-recognizer/dsl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export type Opaque = {} | void | null | undefined;
export interface Route {
path: string;
handler: Opaque;
metadata?: Opaque;
queryParams?: string[];
}

Expand Down Expand Up @@ -105,14 +106,14 @@ function generateMatch(startingPath: string, matcher: Matcher, delegate: Delegat
return match;
}

function addRoute(routeArray: Route[], path: string, handler: any) {
function addRoute(routeArray: Route[], path: string, handler: any, metadata: any) {
let len = 0;
for (let i = 0; i < routeArray.length; i++) {
len += routeArray[i].path.length;
}

path = path.substr(len);
let route = { path: path, handler: handler };
let route = { path: path, handler: handler, metadata: metadata };
routeArray.push(route);
}

Expand All @@ -122,7 +123,7 @@ function eachRoute<T>(baseRoute: Route[], matcher: Matcher, callback: (this: T,
for (let i = 0; i < paths.length; i++) {
let path = paths[i];
let routeArray = baseRoute.slice();
addRoute(routeArray, path, routes[path]);
addRoute(routeArray, path, routes[path], routes.metadata);
let nested = matcher.children[path];
if (nested) {
eachRoute(routeArray, nested, callback, binding);
Expand Down
Loading