Class RouteTrie

A trie data structure that stores routes. The trie supports :param and *wildcard values.

Hierarchy

RouteTrie

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RouteTrie(): RouteTrie

Returns RouteTrie

Properties

Private children

children: Record<string, RouteTrie> = {}

Private Optional paramChild

paramChild: ParamChild

Private Optional route

route: Route

Private Optional wildcardChild

wildcardChild: WildcardChild

Methods

add

add(path: string, route: Route): void

- Defined in trie.ts:79
Adds a route to the trie.

Parameters
- path: string
- route: Route
Returns void

get

get(path: string): [undefined | Route, Record<string, string>]

- Defined in trie.ts:116
Returns a route mapped to the given path and any parameter values from the URL.

Parameters
- path: string
Returns [undefined | Route, Record<string, string>]

Private getRoute

getRoute(path: string, params: Record<string, string>): undefined | Route

- Defined in trie.ts:148
Parameters
- path: string
- params: Record<string, string>
Returns undefined | Route

Private normalizePath

normalizePath(path: string): string

- Defined in trie.ts:186
Normalizes a path for inclusion into the route trie.

Parameters
- path: string
Returns string

Private splitPath

splitPath(path: string): [string, string]

- Defined in trie.ts:197
Splits the parent directory from its children, e.g.:
```
splitPath("foo/bar/baz") -> ["foo", "bar/baz"]
```
Parameters
- path: string
Returns [string, string]

walk

walk(cb: (path: string, route: Route) => void): void

- Defined in trie.ts:125
Walks the route trie and calls a callback function for each route.

Parameters
- cb: (path: string, route: Route) => void
  - - (path: string, route: Route): void
    - Parameters
      - path: string
      - route: Route
      Returns void
Returns void

Generated using TypeDoc