Class Router<Locals>

Type Parameters

Locals extends App.Locals = App.Locals

Hierarchy (View Summary)

Router
- WebServer

Index

Constructors

constructor

new Router<Locals extends Locals = Locals>(): Router<Locals>
Type Parameters
- Locals extends Locals = Locals
Returns Router<Locals>

Accessors

nestedRouters

get nestedRouters(): readonly NestedRouter[]
Returns readonly NestedRouter[]
- Defined in types/router.ts:146

routes

get routes(): readonly Route<any>[]
Returns readonly Route<any>[]
- Defined in types/router.ts:142

Methods

action

action<
    Path extends string,
    OutputData extends Record<string, any> = Record<string, any>,
>(
    path: Path,
    handler: ActionHandler<Path, OutputData>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
- OutputData extends Record<string, any> = Record<string, any>
Parameters
- path: Path
- handler: ActionHandler<Path, OutputData>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:218

canHandleWebSocket

canHandleWebSocket(event: RequestEvent): Promise<boolean>
Check if the router can handle a WebSocket connection for the given path This is used during the upgrade process to validate routes before attempting connection
Parameters
- event: RequestEvent
Returns Promise<boolean>
- Defined in types/router.ts:339

DELETE

DELETE<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:183

discard

discard(
path_or_prefix: string,
method?: "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS",
): this
Parameters
- path_or_prefix: string
- Optionalmethod: "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"
Returns this
- Defined in types/router.ts:303

GET

GET<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:151

handleWebSocket

handleWebSocket(event: RequestEvent, websocket: WebSocket): Promise<boolean>
Parameters
- event: RequestEvent
- websocket: WebSocket
Returns Promise<boolean>
- Defined in types/router.ts:376

HEAD

HEAD<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:191

OPTIONS

OPTIONS<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:199

PATCH

PATCH<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:175

post

post(...handlers: PostHandler<Locals>[]): Router<Locals>
Parameters
- ...handlers: PostHandler<Locals>[]
Returns Router<Locals>
- Defined in types/router.ts:297

POST

POST<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:159

pre

pre(...handlers: PreHandler<Locals>[]): Router<Locals>
Parameters
- ...handlers: PreHandler<Locals>[]
Returns Router<Locals>
- Defined in types/router.ts:292

PUT

PUT<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:167

use

use<InnerLocals extends Locals = Locals>(
router: Router<InnerLocals>,
...middlewares: Middleware<string, Locals>[],
): Router<Locals & InnerLocals>
Type Parameters
- InnerLocals extends Locals = Locals
Parameters
- router: Router<InnerLocals>
- ...middlewares: Middleware<string, Locals>[]
Returns Router<Locals & InnerLocals>
- Defined in types/router.ts:236
use<InnerLocals extends Locals = Locals>(
input: readonly [Router<InnerLocals>, Middleware<string, Locals>],
): Router<Locals & InnerLocals>
Type Parameters
- InnerLocals extends Locals = Locals
Parameters
- input: readonly [Router<InnerLocals>, Middleware<string, Locals>]
Returns Router<Locals & InnerLocals>
- Defined in types/router.ts:237
use<Prefix extends string, InnerLocals extends Locals = Locals>(
    input: readonly [
        Prefix,
        Router<InnerLocals>,
        Middleware<Prefix, Locals>,
    ],
): Router<Locals & InnerLocals>
Type Parameters
- Prefix extends string
- InnerLocals extends Locals = Locals
Parameters
- input: readonly [Prefix, Router<InnerLocals>, Middleware<Prefix, Locals>]
Returns Router<Locals & InnerLocals>
- Defined in types/router.ts:238
use<Prefix extends string, InnerLocals extends Locals = Locals>(
    prefix: Prefix,
    router: Router<InnerLocals>,
    ...middlewares: Middleware<Prefix, Locals>[],
): Router<Locals & InnerLocals>
Type Parameters
- Prefix extends string
- InnerLocals extends Locals = Locals
Parameters
- prefix: Prefix
- router: Router<InnerLocals>
- ...middlewares: Middleware<Prefix, Locals>[]
Returns Router<Locals & InnerLocals>
- Defined in types/router.ts:239

USE

USE<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:208

useMiddleware

useMiddleware<NewLocals extends Locals = Locals>(
...mw: Middleware<string, NewLocals>[],
): Router<Locals & NewLocals>
Type Parameters
- NewLocals extends Locals = Locals
Parameters
- ...mw: Middleware<string, NewLocals>[]
Returns Router<Locals & NewLocals>
- Defined in types/router.ts:285

WS

WS<Path extends string>(
    path: Path,
    handler: WebSocketHandler<Path, Locals>,
    ...middlewares: Middleware<Path, any>[],
): Router<Locals>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: WebSocketHandler<Path, Locals>
- ...middlewares: Middleware<Path, any>[]
Returns Router<Locals>
- Defined in types/router.ts:312

Class Router<Locals>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns Router<Locals>

Accessors

nestedRouters

Returns readonly NestedRouter[]

routes

Returns readonly Route<any>[]

Methods

action

Type Parameters

Parameters

Returns Router<Locals>

canHandleWebSocket

Parameters

Returns Promise<boolean>

DELETE

Type Parameters

Parameters

Returns Router<Locals>

discard

Parameters

Returns this

GET

Type Parameters

Parameters

Returns Router<Locals>

handleWebSocket

Parameters

Returns Promise<boolean>

HEAD

Type Parameters

Parameters

Returns Router<Locals>

OPTIONS

Type Parameters

Parameters

Returns Router<Locals>

PATCH

Type Parameters

Parameters

Returns Router<Locals>

post

Parameters

Returns Router<Locals>

POST

Type Parameters

Parameters

Returns Router<Locals>

pre

Parameters

Returns Router<Locals>

PUT

Type Parameters

Parameters

Returns Router<Locals>

use

Type Parameters

Parameters

Returns Router<Locals & InnerLocals>

Type Parameters

Parameters

Returns Router<Locals & InnerLocals>

Type Parameters

Parameters

Returns Router<Locals & InnerLocals>

Type Parameters

Parameters

Returns Router<Locals & InnerLocals>

USE

Type Parameters

Parameters