Class WebServer<TServerConfig>

Type Parameters

TServerConfig extends ServerConfig = ServerConfig

Hierarchy (View Summary)

Router<InferServerLocals<TServerConfig>>
- WebServer

Index

Constructors

constructor

new WebServer<TServerConfig extends ServerConfig = ServerConfig>(
config?: TServerConfig,
): WebServer<TServerConfig>
Type Parameters
- TServerConfig extends ServerConfig = ServerConfig
Parameters
- Optionalconfig: TServerConfig
Returns WebServer<TServerConfig>
Overrides Router.constructor
- Defined in src/types/server.ts:130

Accessors

listening

get listening(): boolean
Returns boolean
- Defined in src/types/server.ts:257

nestedRouters

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

routes

get routes(): readonly Route<any>[]
Returns readonly Route<any>[]
Inherited from Router.routes
- Defined in src/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<InferServerLocals<TServerConfig>>
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<InferServerLocals<TServerConfig>>
Inherited from Router.action
- Defined in src/types/router.ts:218

address

address(): string | AddressInfo | null
Returns string | AddressInfo | null
- Defined in src/types/server.ts:253

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>
Inherited from Router.canHandleWebSocket
- Defined in src/types/router.ts:350

close

close(callback?: (err?: Error) => void): void
Parameters
- Optionalcallback: (err?: Error) => void
Returns void
- Defined in src/types/server.ts:227

DELETE

DELETE<Path extends string>(
    path: Path,
    handler: RouteHandler<Path, InferServerLocals<TServerConfig>>,
    ...middlewares: Middleware<Path, any>[],
): Router<InferServerLocals<TServerConfig>>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: RouteHandler<Path, InferServerLocals<TServerConfig>>
- ...middlewares: Middleware<Path, any>[]
Returns Router<InferServerLocals<TServerConfig>>
Inherited from Router.DELETE
- Defined in src/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
Inherited from Router.discard
- Defined in src/types/router.ts:314

GET

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

handleWebSocket

handleWebSocket(event: RequestEvent, websocket: WebSocket): Promise<boolean>
Parameters
- event: RequestEvent
- websocket: WebSocket
Returns Promise<boolean>
Inherited from Router.handleWebSocket
- Defined in src/types/router.ts:387

HEAD

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

listen

listen(
    port?: number,
    hostname?: string,
    backlog?: number,
    listeningListener?: () => void,
): this
Parameters
- Optionalport: number
- Optionalhostname: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:159
listen(port?: number, hostname?: string, listeningListener?: () => void): this
Parameters
- Optionalport: number
- Optionalhostname: string
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:160
listen(port?: number, backlog?: number, listeningListener?: () => void): this
Parameters
- Optionalport: number
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:161
listen(port?: number, listeningListener?: () => void): this
Parameters
- Optionalport: number
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:162
listen(path: string, backlog?: number, listeningListener?: () => void): this
Parameters
- path: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:163
listen(path: string, listeningListener?: () => void): this
Parameters
- path: string
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:164
listen(options: ListenOptions, listeningListener?: () => void): this
Parameters
- options: ListenOptions
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:165
listen(handle: any, backlog?: number, listeningListener?: () => void): this
Parameters
- handle: any
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:166
listen(handle: any, listeningListener?: () => void): this
Parameters
- handle: any
- OptionallisteningListener: () => void
Returns this
- Defined in src/types/server.ts:167

middleware

middleware<NewLocals extends Locals = Locals>(
...mw: Middleware<string, NewLocals>[],
): Router<InferServerLocals<TServerConfig> & NewLocals>
Type Parameters
- NewLocals extends Locals = Locals
Parameters
- ...mw: Middleware<string, NewLocals>[]
Returns Router<InferServerLocals<TServerConfig> & NewLocals>
See
useMiddleware
Inherited from Router.middleware
- Defined in src/types/router.ts:296

OPTIONS

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

PATCH

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

post

post(
...handlers: PostHandler<InferServerLocals<TServerConfig>>[],
): Router<InferServerLocals<TServerConfig>>
Parameters
- ...handlers: PostHandler<InferServerLocals<TServerConfig>>[]
Returns Router<InferServerLocals<TServerConfig>>
Inherited from Router.post
- Defined in src/types/router.ts:308

POST

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

pre

pre(
...handlers: PreHandler<InferServerLocals<TServerConfig>>[],
): Router<InferServerLocals<TServerConfig>>
Parameters
- ...handlers: PreHandler<InferServerLocals<TServerConfig>>[]
Returns Router<InferServerLocals<TServerConfig>>
Inherited from Router.pre
- Defined in src/types/router.ts:303

PUT

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

shutdown

shutdown(timeoutMs?: number): Promise<void>
Parameters
- timeoutMs: number = 5000
Returns Promise<void>
- Defined in src/types/server.ts:233

use

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

USE

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

useMiddleware

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

WS

WS<Path extends string>(
    path: Path,
    handler: WebSocketHandler<Path, InferServerLocals<TServerConfig>>,
    ...middlewares: Middleware<Path, any>[],
): Router<InferServerLocals<TServerConfig>>
Type Parameters
- Path extends string
Parameters
- path: Path
- handler: WebSocketHandler<Path, InferServerLocals<TServerConfig>>
- ...middlewares: Middleware<Path, any>[]
Returns Router<InferServerLocals<TServerConfig>>
Inherited from Router.WS
- Defined in src/types/router.ts:323

Class WebServer<TServerConfig>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WebServer<TServerConfig>

Accessors

listening

Returns boolean

nestedRouters

Returns readonly NestedRouter[]

routes

Returns readonly Route<any>[]

Methods

action

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

address

Returns string | AddressInfo | null

canHandleWebSocket

Parameters

Returns Promise<boolean>

close

Parameters

Returns void

DELETE

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

discard

Parameters

Returns this

GET

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

handleWebSocket

Parameters

Returns Promise<boolean>

HEAD

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

listen

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

middleware

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig> & NewLocals>

See

OPTIONS

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

PATCH

Type Parameters