Class Router<T>

A use-case agnostic router for holding and matching routes

Type parameters

T: unknown[]

Where T is the types of the values passed from runPath to the RouteHandler

Hierarchy

Router

Index

Properties

routes

Methods

Properties

routes

routes: Route<T>[] = []

The list of routes

Methods

addRoute

addRoute(route: string, handler: RouteHandler<T>): void

- Defined in router.ts:99
Adds a route to match when testing paths

The route handler is the callback that is executed when the program

Parameters
- route: string
- handler: RouteHandler<T>
Returns void

findRoute

findRoute(path: string): undefined | Route<T>

- Defined in router.ts:89
Find a route that matches the path, returns undefined if nothing is found

Parameters
- path: string
Returns undefined | Route<T>

runPath

runPath(path: string, ...data: T): void

- Defined in router.ts:108
Find and run the route handler for the path if any matches are found

Optionally data can be passed to the handler

Parameters
- path: string
- Rest ...data: T
Returns void

Generated using TypeDoc