Class Application

A class representing a web application, extending the functionality of HttpServer.

Hierarchy

HttpServer
- Application

Index

Constructors

Properties

errorMiddleware handler logger requestHandlers server

Methods

acceptNextClient close delete get handleRequest options patch post put use useGlobalErrorHandler

Constructors

constructor

new Application(bindAddress, port): Application
Constructs a new Application instance.
Parameters
- bindAddress: string
  The network address the server will bind to.
- port: number
  The port number the server will listen on.
Returns Application
Overrides HttpServer.constructor
- Defined in tslua-http-api/src/application.ts:220

Properties

`Protected` errorMiddleware

errorMiddleware: AppErrorMiddleware

`Protected` `Readonly` handler

handler: RequestHandler

`Protected` logger

logger: Logger

`Protected` requestHandlers

requestHandlers: {
    method?: string;
    middleware: AppMiddleware;
    route: string;
}[]

Type declaration

Optional method?: string
middleware: AppMiddleware
route: string

`Protected` server

server: TCP

The underlying TCP server.

Methods

acceptNextClient

acceptNextClient(): void
Accepts the next client connection. When a client connects, it handles the client's request.

Returns void
Example
```
// Accept and handle the next client
httpServer.acceptNextClient();
```
Inherited from HttpServer.acceptNextClient
- Defined in tslua-http/dist/server.d.ts:44

close

close(): void
Returns void
Inherited from HttpServer.close
- Defined in tslua-http/dist/server.d.ts:35

delete

delete(route, ...middleware): void
Registers a DELETE request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:280

get

get(route, ...middleware): void
Registers a GET request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:253

`Private` handleRequest

handleRequest(req, res): HttpResponse
Internal method to handle incoming HTTP requests.
Parameters
- req: HttpRequest<Record<string, string>>
  The HttpRequest object.
- res: HttpResponse
  The HttpResponse object.
Returns HttpResponse
The HttpResponse object after processing.
- Defined in tslua-http-api/src/application.ts:310

options

options(route, ...middleware): void
Registers an OPTIONS request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:298

patch

patch(route, ...middleware): void
Registers a PATCH request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:289

post

post(route, ...middleware): void
Registers a POST request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:271

put

put(route, ...middleware): void
Registers a PUT request handler.
Parameters
- route: string
- Rest ...middleware: AppMiddleware[]
Returns void
- Defined in tslua-http-api/src/application.ts:262

use

use(route, ...middleware): void
Registers a request handler for all HTTP methods on a specific route.
Parameters
- route: string
  The route pattern to match.
- Rest ...middleware: AppMiddleware[]
  The handler function to execute.
Returns void
- Defined in tslua-http-api/src/application.ts:238

useGlobalErrorHandler

useGlobalErrorHandler(middleware): void
Parameters
- middleware: AppErrorMiddleware
Returns void
- Defined in tslua-http-api/src/application.ts:244

Generated using TypeDoc