Class HttpResultFormatter

Hierarchy

HttpResultFormatter

Index

Constructors

Properties

htmlContentType jsonContentType router

Methods

handle handleBinary handleError handleGenericResponse handleHtmlResponse handleJSONResponse handleRedirect handleResponse handleStream handleTypeEntity handleUndefined handleUnknown setContentTypeIfNotSetAlready

Constructors

constructor

new HttpResultFormatter(router: HttpRouter): HttpResultFormatter
Parameters
- router: HttpRouter
Returns HttpResultFormatter
- Defined in packages/http/src/http.ts:396

Properties

`Protected` htmlContentType

htmlContentType: string = 'text/html; charset=utf-8'

`Protected` jsonContentType

jsonContentType: string = 'application/json; charset=utf-8'

`Protected` router

router: HttpRouter

Methods

handle

handle(result: SupportedHttpResult, context: HttpResultFormatterContext): void
Parameters
- result: SupportedHttpResult
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:468

handleBinary

handleBinary(result: Uint8Array, context: HttpResultFormatterContext): void
Parameters
- result: Uint8Array
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:461

handleError

handleError(error: Error, context: HttpResultFormatterContext): void
Parameters
- error: Error
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:405

handleGenericResponse

handleGenericResponse(result: Response, context: HttpResultFormatterContext): void
Parameters
- result: Response
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:438

handleHtmlResponse

handleHtmlResponse(result: HtmlResponse, context: HttpResultFormatterContext): void
Parameters
- result: HtmlResponse
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:432

handleJSONResponse

handleJSONResponse(result: JSONResponse, context: HttpResultFormatterContext): void
Parameters
- result: JSONResponse
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:443

handleRedirect

handleRedirect(result: Redirect, context: HttpResultFormatterContext): void
Parameters
- result: Redirect
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:413

handleResponse

handleResponse(context: HttpResultFormatterContext): void
Parameters
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:465

handleStream

handleStream(stream: Readable, context: HttpResultFormatterContext): void
Parameters
- stream: Readable
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:457

handleTypeEntity

handleTypeEntity<T>(classType: ClassType<T>, instance: T, context: HttpResultFormatterContext, route?: RouteConfig): void
Type Parameters
- T
Parameters
- classType: ClassType<T>
- instance: T
- context: HttpResultFormatterContext
- Optional route: RouteConfig
Returns void
- Defined in packages/http/src/http.ts:449

handleUndefined

handleUndefined(result: undefined | null, context: HttpResultFormatterContext): void
Parameters
- result: undefined | null
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:409

handleUnknown

handleUnknown(result: any, context: HttpResultFormatterContext): void
Parameters
- result: any
- context: HttpResultFormatterContext
Returns void
- Defined in packages/http/src/http.ts:426

`Protected` setContentTypeIfNotSetAlready

setContentTypeIfNotSetAlready(response: HttpResponse, contentType: string): void
Parameters
- response: HttpResponse
- contentType: string
Returns void
- Defined in packages/http/src/http.ts:399

Generated using TypeDoc