diff --git a/docs/classes/Router.html b/docs/classes/Router.html index 192d318..a9cfabe 100644 --- a/docs/classes/Router.html +++ b/docs/classes/Router.html @@ -10,47 +10,47 @@ put static use -

Constructors

constructor

Methods

delete

  • delete(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP DELETE requests.

    +

Constructors

constructor

Methods

delete

  • delete(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

get

  • get(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP GET requests.

    +

get

  • get(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

getRoute

  • getRoute(path: string, method: string): any

    Finds and returns the route matching the given path and method.

    +

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.

    -

group

  • group(basePath: string | RegExp, callback: (methods: any) => void): this

    Registers a new route group with common base path and middleware.

    +

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.

    -

head

  • head(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP HEAD requests.

    +

head

  • head(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

importRoutesFromPath

  • importRoutesFromPath(p: string, tpl?: false | Tpl): Promise<Router>

    Dynamically imports routes from a directory and registers them.

    +

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.

    -

patch

  • patch(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP PATCH requests.

    +

patch

  • patch(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

post

  • post(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP POST requests.

    +

post

  • post(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

put

  • put(path: string | RegExp, cb: Handler[]): this

    Registers a route for HTTP PUT requests.

    +

put

  • put(path: string | RegExp, ...callback: 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.

      +
    • ...callback: Handler[]

      An array of middleware or handler functions to execute for this route.

    Returns this

    The current instance for method chaining.

    -

static

  • static(options: { dir?: string; route?: RegExp }): this

    Serves static files from a specified directory.

    +

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.

    -

use

  • use(obj: Tpl | Router): void

    Merges routes or assigns a template instance to the Router.

    +

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

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods