Class Router

Index

Constructors

Methods

delete get getRoute group head importRoutesFromPath patch post put static use

Constructors

constructor

new Router(): Router
Returns Router
- Defined in router.ts:12

Methods

delete

delete(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP DELETE requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:157

get

get(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP GET requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:113

getRoute

getRoute(path: string, method: string): any
Finds and returns the route matching the given path and method.
Parameters
- path: string
  The requested path.
- method: string
  The HTTP method (e.g., "GET").
Returns any
The matching route or undefined.
- Defined in router.ts:201

group

group(basePath: string | RegExp, callback: (methods: any) => void): this
Registers a new route group with common base path and middleware.
Parameters
- basePath: string | RegExp
  The base path or RegExp.
- callback: (methods: any) => void
  Callback to define routes within the group.
Returns this
The Router instance for chaining.
- Defined in router.ts:43

head

head(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP HEAD requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:135

importRoutesFromPath

importRoutesFromPath(p: string, tpl?: false | Tpl): Promise<Router>
Dynamically imports routes from a directory and registers them.
Parameters
- p: string
  Path to the directory containing route files.
- tpl: false | Tpl = false
  Optional template instance to use with the routes.
Returns Promise<Router>
The Router instance for chaining.
- Defined in router.ts:23

patch

patch(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP PATCH requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:168

post

post(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP POST requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:124

put

put(path: string | RegExp, cb: Handler[]): this
Registers a route for HTTP PUT requests.
Parameters
- path: string | RegExp
  The URL path or pattern for the route.
- cb: Handler[]
  An array of middleware or handler functions to execute for this route.
Returns this
The current instance for method chaining.
- Defined in router.ts:146

static

static(options: { dir?: string; route?: RegExp }): this
Serves static files from a specified directory.
Parameters
- options: { dir?: string; route?: RegExp }
  Options for serving static files.
  - Optionaldir?: string
    Directory containing the static files.
  - Optionalroute?: RegExp
    Regular expression to match the route for static files.
Returns this
The Router instance for chaining.
- Defined in router.ts:238

use

use(obj: Tpl | Router): void
Merges routes or assigns a template instance to the Router.
Parameters
- obj: Tpl | Router
  An instance of Router or Tpl.
Returns void
- Defined in router.ts:97