Class AppHttpRequest<PARAMS, QUERY, BODY>

Type Parameters

PARAMS = any
QUERY = any
BODY = any

Index

Constructors

Properties

__params logger req

Accessors

body headers method originalUrl params path protocol query

Methods

getBody getBodyOrThrow getHeaderValue getHeaderValueOrThrow getPathParameterValue getPathParameterValueOrThrow getQueryParameterValue getQueryParameterValueOrThrow

Constructors

constructor

new AppHttpRequest<PARAMS = any, QUERY = any, BODY = any>(
    app: Application,
    req: HttpRequest,
    pathParams: Record<string, string>,
): AppHttpRequest<PARAMS, QUERY, BODY>
Type Parameters
- PARAMS = any
- QUERY = any
- BODY = any
Parameters
- app: Application
- req: HttpRequest
- pathParams: Record<string, string>
Returns AppHttpRequest<PARAMS, QUERY, BODY>
- Defined in packages/tslua-http-api/src/application.ts:74

Properties

__params

__params: Record<string, string>

`Protected`logger

logger: Logger = ...

`Readonly`req

req: HttpRequest

Accessors

body

get body(): BODY | undefined
Returns BODY | undefined
Deprecated
Use getBody and getBodyOrThrow
- Defined in packages/tslua-http-api/src/application.ts:26

headers

get headers(): Record<string, string>
Returns Record<string, string>
Deprecated
Use getHeaderValue and getHeaderValueOrThrow
- Defined in packages/tslua-http-api/src/application.ts:54

method

get method(): string
Returns string
- Defined in packages/tslua-http-api/src/application.ts:58

originalUrl

get originalUrl(): string
Returns string
- Defined in packages/tslua-http-api/src/application.ts:62

params

get params(): PARAMS
Returns PARAMS
Deprecated
Use getPathParameterValue and getPathParameterValueOrThrow
- Defined in packages/tslua-http-api/src/application.ts:45

path

get path(): string
Returns string
- Defined in packages/tslua-http-api/src/application.ts:70

protocol

get protocol(): string
Returns string
- Defined in packages/tslua-http-api/src/application.ts:66

query

get query(): QUERY
Returns QUERY
Deprecated
Use getQueryParameterValue and getQueryParameterValueOrThrow
- Defined in packages/tslua-http-api/src/application.ts:19

Methods

getBody

getBody<T = string>(): T
Type Parameters
- T = string
Returns T
- Defined in packages/tslua-http-api/src/application.ts:96

getBodyOrThrow

getBodyOrThrow<T = string>(error?: Error): T
Type Parameters
- T = string
Parameters
- error: Error = ...
Returns T
- Defined in packages/tslua-http-api/src/application.ts:100

getHeaderValue

getHeaderValue<T>(key: string): T
Type Parameters
- T
Parameters
- key: string
Returns T
- Defined in packages/tslua-http-api/src/application.ts:82

getHeaderValueOrThrow

getHeaderValueOrThrow<T>(key: string, error?: Error): T
Type Parameters
- T
Parameters
- key: string
- error: Error = ...
Returns T
- Defined in packages/tslua-http-api/src/application.ts:86

getPathParameterValue

getPathParameterValue<T = string>(key: string): T
Type Parameters
- T = string
Parameters
- key: string
Returns T
- Defined in packages/tslua-http-api/src/application.ts:121

getPathParameterValueOrThrow

getPathParameterValueOrThrow<T = string>(key: string, error?: Error): T
Type Parameters
- T = string
Parameters
- key: string
- error: Error = ...
Returns T
- Defined in packages/tslua-http-api/src/application.ts:125

getQueryParameterValue

getQueryParameterValue<T = string>(key: string): T
Type Parameters
- T = string
Parameters
- key: string
Returns T
- Defined in packages/tslua-http-api/src/application.ts:107

getQueryParameterValueOrThrow

getQueryParameterValueOrThrow<T = string>(key: string, error?: Error): T
Type Parameters
- T = string
Parameters
- key: string
- error: Error = ...
Returns T
- Defined in packages/tslua-http-api/src/application.ts:111