Class AbstractHttpAdapter<TServer, TRequest, TResponse>

publicapi

Type parameters

TServer = any
TRequest = any
TResponse = any

Hierarchy

AbstractHttpAdapter
- NoopHttpAdapter

Implements

HttpServer<TRequest, TResponse>

Index

Constructors

constructor

Properties

Constructors

constructor

new AbstractHttpAdapter(instance: any): AbstractHttpAdapter

- Defined in packages/core/adapters/http-adapter.ts:14
Parameters
- instance: any
Returns AbstractHttpAdapter

Properties

Protected httpServer

httpServer: TServer

Protected Readonly instance

instance: any

Methods

Abstract close

close(): any

- Defined in packages/core/adapters/http-adapter.ts:85
Returns any

Abstract createMiddlewareFactory

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

- Defined in packages/core/adapters/http-adapter.ts:101
Parameters
- requestMethod: RequestMethod
Returns ((path: string, callback: Function) => any) | Promise<(path: string, callback: Function) => any>

delete

delete(handler: RequestHandler): any
delete(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:43
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:44
Parameters
- path: any
- handler: RequestHandler
Returns any

Abstract enableCors

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

- Defined in packages/core/adapters/http-adapter.ts:100
Parameters
- options: CorsOptions
- Optional prefix: string
Returns any

get

get(handler: RequestHandler): any
get(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:25
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:26
Parameters
- path: any
- handler: RequestHandler
Returns any

getHttpServer

getHttpServer(): TServer

- Defined in packages/core/adapters/http-adapter.ts:73
Returns TServer

getInstance

getInstance<T>(): T

- Defined in packages/core/adapters/http-adapter.ts:81
Type parameters
- T = any
Returns T

Abstract getRequestHostname

getRequestHostname(request: any): any

- Defined in packages/core/adapters/http-adapter.ts:89
Parameters
- request: any
Returns any

Abstract getRequestMethod

getRequestMethod(request: any): any

- Defined in packages/core/adapters/http-adapter.ts:90
Parameters
- request: any
Returns any

Abstract getRequestUrl

getRequestUrl(request: any): any

- Defined in packages/core/adapters/http-adapter.ts:91
Parameters
- request: any
Returns any

Abstract getType

getType(): string

- Defined in packages/core/adapters/http-adapter.ts:106
Returns string

head

head(handler: RequestHandler): any
head(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:37
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:38
Parameters
- path: any
- handler: RequestHandler
Returns any

init

init(): Promise<void>

- Defined in packages/core/adapters/http-adapter.ts:19
Returns Promise<void>

Abstract initHttpServer

initHttpServer(options: NestApplicationOptions): any

- Defined in packages/core/adapters/http-adapter.ts:86
Parameters
- options: NestApplicationOptions
Returns any

listen

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

- Defined in packages/core/adapters/http-adapter.ts:67
Parameters
- port: string | number
- Optional callback: () => void
  - - (): void
    - Returns void
Returns any
- Defined in packages/core/adapters/http-adapter.ts:68
Parameters
- port: string | number
- hostname: string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns any

options

options(handler: RequestHandler): any
options(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:61
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:62
Parameters
- path: any
- handler: RequestHandler
Returns any

patch

patch(handler: RequestHandler): any
patch(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:55
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:56
Parameters
- path: any
- handler: RequestHandler
Returns any

post

post(handler: RequestHandler): any
post(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:31
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:32
Parameters
- path: any
- handler: RequestHandler
Returns any

put

put(handler: RequestHandler): any
put(path: any, handler: RequestHandler): any

- Defined in packages/core/adapters/http-adapter.ts:49
Parameters
- handler: RequestHandler
Returns any
- Defined in packages/core/adapters/http-adapter.ts:50
Parameters
- path: any
- handler: RequestHandler
Returns any

Abstract redirect

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

- Defined in packages/core/adapters/http-adapter.ts:95
Parameters
- response: any
- statusCode: number
- url: string
Returns any

Abstract registerParserMiddleware

registerParserMiddleware(prefix?: string): any

- Defined in packages/core/adapters/http-adapter.ts:99
Parameters
- Optional prefix: string
Returns any

Abstract render

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

- Defined in packages/core/adapters/http-adapter.ts:94
Parameters
- response: any
- view: string
- options: any
Returns any

Abstract reply

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

- Defined in packages/core/adapters/http-adapter.ts:93
Parameters
- response: any
- body: any
- Optional statusCode: number
Returns any

Abstract setErrorHandler

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

- Defined in packages/core/adapters/http-adapter.ts:96
Parameters
- handler: Function
- Optional prefix: string
Returns any

Abstract setHeader

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

- Defined in packages/core/adapters/http-adapter.ts:98
Parameters
- response: any
- name: string
- value: string
Returns any

setHttpServer

setHttpServer(httpServer: TServer): void

- Defined in packages/core/adapters/http-adapter.ts:77
Parameters
- httpServer: TServer
Returns void

Abstract setNotFoundHandler

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

- Defined in packages/core/adapters/http-adapter.ts:97
Parameters
- handler: Function
- Optional prefix: string
Returns any

Abstract setViewEngine

setViewEngine(engine: string): any

- Defined in packages/core/adapters/http-adapter.ts:88
Parameters
- engine: string
Returns any

Abstract status

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

- Defined in packages/core/adapters/http-adapter.ts:92
Parameters
- response: any
- statusCode: number
Returns any

use

use(...args: any[]): any

- Defined in packages/core/adapters/http-adapter.ts:21
Parameters
- Rest ...args: any[]
Returns any

Abstract useStaticAssets

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

- Defined in packages/core/adapters/http-adapter.ts:87
Parameters
- Rest ...args: any[]
Returns any

Generated using TypeDoc