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 types/server.ts:107

Accessors

listening

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

nestedRouters

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

routes

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

address

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

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 types/router.ts:322

close

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

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 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 types/router.ts:286

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 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 types/router.ts:359

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 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 types/server.ts:134
listen(port?: number, hostname?: string, listeningListener?: () => void): this
Parameters
- Optionalport: number
- Optionalhostname: string
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:135
listen(port?: number, backlog?: number, listeningListener?: () => void): this
Parameters
- Optionalport: number
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:136
listen(port?: number, listeningListener?: () => void): this
Parameters
- Optionalport: number
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:137
listen(path: string, backlog?: number, listeningListener?: () => void): this
Parameters
- path: string
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:138
listen(path: string, listeningListener?: () => void): this
Parameters
- path: string
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:139
listen(options: ListenOptions, listeningListener?: () => void): this
Parameters
- options: ListenOptions
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:140
listen(handle: any, backlog?: number, listeningListener?: () => void): this
Parameters
- handle: any
- Optionalbacklog: number
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:141
listen(handle: any, listeningListener?: () => void): this
Parameters
- handle: any
- OptionallisteningListener: () => void
Returns this
- Defined in types/server.ts:142

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 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 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 types/router.ts:280

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 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 types/router.ts:275

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 types/router.ts:167

use

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 types/router.ts:236
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 types/router.ts:237

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 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 types/router.ts:268

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 types/router.ts:295

`Static`New

New(): Router
Returns Router
Inherited from Router.New
- Defined in types/router.ts:725

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

OPTIONS

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

PATCH

Type Parameters

Parameters

Returns Router<InferServerLocals<TServerConfig>>

post

Parameters

Returns Router<InferServerLocals<TServerConfig>>

`Static`New