AbstractHttpAdapter

  
abstract class AbstractHttpAdapter<TServer = any, TRequest = any, TResponse = any> implements HttpServer {
  constructor(instance?: any)
  protected httpServer: TServer
  protected instance?: any
  init()
  use(...args: any[])
  get(...args: any[])
  post(...args: any[])
  head(...args: any[])
  delete(...args: any[])
  put(...args: any[])
  patch(...args: any[])
  all(...args: any[])
  options(...args: any[])
  listen(port: any, hostname?: any, callback?: any)
  getHttpServer(): TServer
  setHttpServer(httpServer: TServer)
  setInstance<T = any>(instance: T)
  getInstance<T = any>(): T
  abstract close()
  abstract initHttpServer(options: NestApplicationOptions)
  abstract useStaticAssets(...args: any[])
  abstract setViewEngine(engine: string)
  abstract getRequestHostname(request: any)
  abstract getRequestMethod(request: any)
  abstract getRequestUrl(request: any)
  abstract status(response: any, statusCode: number)
  abstract reply(response: any, body: any, statusCode?: number)
  abstract end(response: any, message?: string)
  abstract render(response: any, view: string, options: any)
  abstract redirect(response: any, statusCode: number, url: string)
  abstract setErrorHandler(handler: Function, prefix?: string)
  abstract setNotFoundHandler(handler: Function, prefix?: string)
  abstract isHeadersSent(response: any)
  abstract setHeader(response: any, name: string, value: string)
  abstract registerParserMiddleware(prefix?: string, rawBody?: boolean)
  abstract enableCors(options: any, prefix?: string)
  abstract createMiddlewareFactory(requestMethod: RequestMethod): ((path: string, callback: Function) => any) | Promise<(path: string, callback: Function) => any>
  abstract getType(): string
  abstract applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): (req: TRequest, res: TResponse, next: () => void) => Function
}

Constructor


constructor(instance?: any)

Parameters

Option Type Description
instance any

Optional. Default is undefined.

Properties

Property Description
protected httpServer: TServer
protected instance?: any Declared in constructor.

Methods

init()


init()

Parameters

There are no parameters.

use()


use(...args: any[])

Parameters

Option Type Description
args any[]

get()


get(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

get(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

post()


post(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

post(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

head()


head(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

head(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

delete()


delete(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

delete(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

put()


put(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

put(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

patch()


patch(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

patch(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

all()


all(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

all(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

options()


options(handler: RequestHandler)

Parameters

Option Type Description
handler RequestHandler

options(path: any, handler: RequestHandler)

Parameters

Option Type Description
path any
handler RequestHandler

listen()


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

Parameters

Option Type Description
port string | number
callback () => void

Optional. Default is undefined.


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

Parameters

Option Type Description
port string | number
hostname string
callback () => void

Optional. Default is undefined.

getHttpServer()


getHttpServer(): TServer

Parameters

There are no parameters.

Returns

TServer

setHttpServer()


setHttpServer(httpServer: TServer)

Parameters

Option Type Description
httpServer TServer

setInstance()


setInstance<T = any>(instance: T)

Parameters

Option Type Description
instance T

getInstance()


getInstance<T = any>(): T

Parameters

There are no parameters.

Returns

T

close()


abstract close()

Parameters

There are no parameters.

initHttpServer()


abstract initHttpServer(options: NestApplicationOptions)

Parameters

Option Type Description
options NestApplicationOptions

useStaticAssets()


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

Parameters

Option Type Description
args any[]

setViewEngine()


abstract setViewEngine(engine: string)

Parameters

Option Type Description
engine string

getRequestHostname()


abstract getRequestHostname(request: any)

Parameters

Option Type Description
request any

getRequestMethod()


abstract getRequestMethod(request: any)

Parameters

Option Type Description
request any

getRequestUrl()


abstract getRequestUrl(request: any)

Parameters

Option Type Description
request any

status()


abstract status(response: any, statusCode: number)

Parameters

Option Type Description
response any
statusCode number

reply()


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

Parameters

Option Type Description
response any
body any
statusCode number

Optional. Default is undefined.

end()


abstract end(response: any, message?: string)

Parameters

Option Type Description
response any
message string

Optional. Default is undefined.

render()


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

Parameters

Option Type Description
response any
view string
options any

redirect()


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

Parameters

Option Type Description
response any
statusCode number
url string

setErrorHandler()


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

Parameters

Option Type Description
handler Function
prefix string

Optional. Default is undefined.

setNotFoundHandler()


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

Parameters

Option Type Description
handler Function
prefix string

Optional. Default is undefined.

isHeadersSent()


abstract isHeadersSent(response: any)

Parameters

Option Type Description
response any

setHeader()


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

Parameters

Option Type Description
response any
name string
value string

registerParserMiddleware()


abstract registerParserMiddleware(prefix?: string, rawBody?: boolean)

Parameters

Option Type Description
prefix string

Optional. Default is undefined.

rawBody boolean

Optional. Default is undefined.

enableCors()


abstract enableCors(options: any, prefix?: string)

Parameters

Option Type Description
options any
prefix string

Optional. Default is undefined.

createMiddlewareFactory()


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

Parameters

Option Type Description
requestMethod RequestMethod

Returns

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

getType()


abstract getType(): string

Parameters

There are no parameters.

Returns

string

applyVersionFilter()


abstract applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): (req: TRequest, res: TResponse, next: () => void) => Function

Parameters

Option Type Description
handler Function
version VersionValue
versioningOptions VersioningOptions

Returns

(req: TRequest, res: TResponse, next: () => void) => Function