Class Application

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

Hierarchy (View Summary)

HttpServer
- Application

Index

Constructors

Properties

errorMiddleware errors handler logger requestHandlers server

Methods

acceptNextClient close delete get options patch post put use useGlobalErrorHandler useMiddleware

Constructors

constructor

new Application(bindAddress: string, port: number): 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:240

Properties

`Protected`errorMiddleware

errorMiddleware: AppErrorMiddleware

errors

errors: { error: Error; [key: string]: any }[] = []

`Protected` `Readonly`handler

handler: RequestHandler

The request handler to be used when serving requests

`Protected`logger

logger: Logger

`Protected`requestHandlers

requestHandlers: { 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:43

close

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

delete

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

get

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

options

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

patch

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

post

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

put

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

use

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

useGlobalErrorHandler

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

useMiddleware

useMiddleware(middleware: AppMiddleware): void
Parameters
- middleware: AppMiddleware
Returns void
- Defined in tslua-http-api/src/application.ts:264