Class App

Hierarchy

MiddlewareManager
- App

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new App(__namedParameters: AppOptions): App

Overrides MiddlewareManager.constructor
- Defined in classes/App.ts:34
Parameters
- __namedParameters: AppOptions
Returns App

Properties

Readonly debug

debug: boolean

Readonly keys

keys: null | { ca: string; cert: string; privkey: string }

middlewares

middlewares: MiddlewareFunctionExecute[]

Readonly ports

ports: { http: null | number; https: null | number }

Type declaration

http: null | number
https: null | number

routes

routes: Route[]

Protected servers

servers: { http: Server; https: null | Server }

Type declaration

http: Server
https: null | Server

Readonly staticRoutes

staticRoutes: StaticRoute[]

Methods

Private _handleRequest

_handleRequest(req: IncomingMessage, res: ServerResponse, isHTTP: boolean): Promise<void>

- Defined in classes/App.ts:112
Parameters
- req: IncomingMessage
- res: ServerResponse
- isHTTP: boolean
Returns Promise<void>

_handleRoute

_handleRoute(req: Request, res: Response, staticRoutes: StaticRoute[]): Promise<void>

Inherited from MiddlewareManager._handleRoute
- Defined in classes/RouteManager.ts:57
Parameters
- req: Request
- res: Response
- staticRoutes: StaticRoute[]
Returns Promise<void>

_handleRouteError

_handleRouteError(req: Request, res: Response, err: Error): Promise<void>

Inherited from MiddlewareManager._handleRouteError
- Defined in classes/RouteManager.ts:117
Parameters
- req: Request
- res: Response
- err: Error
Returns Promise<void>

all

all(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:214
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

createMiddleware

createMiddleware(middlewareFunc: MiddlewareFunctionExecute): void

Inherited from MiddlewareManager.createMiddleware
- Defined in classes/MiddlewareManager.ts:16
Parameters
- middlewareFunc: MiddlewareFunctionExecute
Returns void

delete

delete(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:206
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

executeMiddlewares

executeMiddlewares(req: Request, res: Response): [Request, Response]

Inherited from MiddlewareManager.executeMiddlewares
- Defined in classes/MiddlewareManager.ts:20
Parameters
- req: Request
- res: Response
Returns [Request, Response]

get

get(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:190
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

handleStaticRoteError

handleStaticRoteError(res: Response): Promise<void>

Inherited from MiddlewareManager.handleStaticRoteError
- Defined in classes/RouteManager.ts:151
Parameters
- res: Response
Returns Promise<void>

head

head(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:194
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

patch

patch(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:210
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

post

post(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:198
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

put

put(route: string, routeFunction: RouteFunctionExecute): void

- Defined in classes/App.ts:202
Parameters
- route: string
- routeFunction: RouteFunctionExecute
Returns void

registerRoute

registerRoute(path: string, methods: HTTPMethods | HTTPMethods[], routeFunction: RouteFunctionExecute): void

Inherited from MiddlewareManager.registerRoute
- Defined in classes/RouteManager.ts:19
Parameters
- path: string
- methods: HTTPMethods | HTTPMethods[]
- routeFunction: RouteFunctionExecute
Returns void

serve

serve(urlPath: string, folderPath: string): StaticRoute

- Defined in classes/App.ts:159
Parameters
- urlPath: string
- folderPath: string
Returns StaticRoute

start

start(httpPort: number, started?: () => void): void

- Defined in classes/App.ts:69
Parameters
- httpPort: number
- Optional started: () => void
  - - (): void
    - Returns void
Returns void

useRouter

useRouter(router: Router): void

- Defined in classes/App.ts:177
Parameters
- router: Router
Returns void

Generated using TypeDoc