Interface HttpServer<TRequest, TResponse>

Type parameters

TRequest = any
TResponse = any

Hierarchy

HttpServer

Methods

close

close(): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:68
Returns any

createMiddlewareFactory

createMiddlewareFactory(method: RequestMethod): ((path: string, callback: Function) => any) | Promise<(path: string, callback: Function) => any>

- Defined in packages/common/interfaces/http/http-server.interface.ts:55
Parameters
- method: RequestMethod
Returns ((path: string, callback: Function) => any) | Promise<(path: string, callback: Function) => any>

delete

delete(handler: RequestHandler<TRequest, TResponse>): any
delete(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:35
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:36
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

enableCors

enableCors(options: CorsOptions): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:65
Parameters
- options: CorsOptions
Returns any

get

get(handler: RequestHandler<TRequest, TResponse>): any
get(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:29
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:30
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

getHttpServer

getHttpServer(): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:66
Returns any

getInstance

getInstance(): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:63
Returns any

Optional getRequestHostname

getRequestHostname(request: TRequest): string

- Defined in packages/common/interfaces/http/http-server.interface.ts:60
Parameters
- request: TRequest
Returns string

Optional getRequestMethod

getRequestMethod(request: TRequest): string

- Defined in packages/common/interfaces/http/http-server.interface.ts:61
Parameters
- request: TRequest
Returns string

Optional getRequestUrl

getRequestUrl(request: TResponse): string

- Defined in packages/common/interfaces/http/http-server.interface.ts:62
Parameters
- request: TResponse
Returns string

getType

getType(): string

- Defined in packages/common/interfaces/http/http-server.interface.ts:69
Returns string

head

head(handler: RequestHandler<TRequest, TResponse>): any
head(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:33
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:34
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

Optional init

init(): Promise<void>

- Defined in packages/common/interfaces/http/http-server.interface.ts:70
Returns Promise<void>

initHttpServer

initHttpServer(options: NestApplicationOptions): void

- Defined in packages/common/interfaces/http/http-server.interface.ts:67
Parameters
- options: NestApplicationOptions
Returns void

listen

listen(port: number | string, callback?: () => void): any
listen(port: number | string, hostname: string, callback?: () => void): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:43
Parameters
- port: number | string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:44
Parameters
- port: number | string
- hostname: string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns any

options

options(handler: RequestHandler<TRequest, TResponse>): any
options(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:41
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:42
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

patch

patch(handler: RequestHandler<TRequest, TResponse>): any
patch(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:39
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:40
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

post

post(handler: RequestHandler<TRequest, TResponse>): any
post(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:31
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:32
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

put

put(handler: RequestHandler<TRequest, TResponse>): any
put(path: string, handler: RequestHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:37
Parameters
- handler: RequestHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:38
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse>
Returns any

redirect

redirect(response: any, statusCode: number, url: string): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:48
Parameters
- response: any
- statusCode: number
- url: string
Returns any

registerParserMiddleware

registerParserMiddleware(): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:64
Returns any

render

render(response: any, view: string, options: any): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:47
Parameters
- response: any
- view: string
- options: any
Returns any

reply

reply(response: any, body: any, statusCode?: number): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:45
Parameters
- response: any
- body: any
- Optional statusCode: number
Returns any

Optional setBaseViewsDir

setBaseViewsDir(path: string | string[]): this

- Defined in packages/common/interfaces/http/http-server.interface.ts:53
Parameters
- path: string | string[]
Returns this

Optional setErrorHandler

setErrorHandler(handler: Function, prefix?: string): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:50
Parameters
- handler: Function
- Optional prefix: string
Returns any

setHeader

setHeader(response: any, name: string, value: string): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:49
Parameters
- response: any
- name: string
- value: string
Returns any

Optional setNotFoundHandler

setNotFoundHandler(handler: Function, prefix?: string): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:51
Parameters
- handler: Function
- Optional prefix: string
Returns any

Optional setViewEngine

setViewEngine(engineOrOptions: any): this

- Defined in packages/common/interfaces/http/http-server.interface.ts:54
Parameters
- engineOrOptions: any
Returns this

status

status(response: any, statusCode: number): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:46
Parameters
- response: any
- statusCode: number
Returns any

use

use(handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>): any
use(path: string, handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>): any

- Defined in packages/common/interfaces/http/http-server.interface.ts:18
Parameters
- handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>
Returns any
- Defined in packages/common/interfaces/http/http-server.interface.ts:23
Parameters
- path: string
- handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>
Returns any

Optional useStaticAssets

useStaticAssets(...args: any[]): this

- Defined in packages/common/interfaces/http/http-server.interface.ts:52
Parameters
- Rest ...args: any[]
Returns this

Generated using TypeDoc