Class Request<TBody, TAuthToken>

Type Parameters

TBody = any
TAuthToken extends IAuthTokenData = IAuthTokenData

Constructors

constructor

new Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthTokenData>(
request: Request,
): Request<TBody, TAuthToken>
Type Parameters
- TBody = any
- TAuthToken extends IAuthTokenData = IAuthTokenData
Parameters
- request: Request
Returns Request<TBody, TAuthToken>
- Defined in src/Request.ts:50

Methods

getAuthenticationToken

getAuthenticationToken(): Promise<TAuthToken>
Returns Promise<TAuthToken>
- Defined in src/Request.ts:259

getBody

getBody(): TBody
Returns TBody
- Defined in src/Request.ts:54

getDatabasePosition

getDatabasePosition(): IDatabasePosition
Reads the Page/Position DB headers if present Will return null if headers are not parseable.

Returns IDatabasePosition
Since
9.1.0
- Defined in src/Request.ts:230

getForm

getForm(): Promise<IFormData>
Returns Promise<IFormData>
- Defined in src/Request.ts:58

getForwardedIP

getForwardedIP(): string
Returns string
- Defined in src/Request.ts:191

getHeader

getHeader(name: string): string
Parameters
- name: string
Returns string
- Defined in src/Request.ts:82

getHeaders

getHeaders(): IncomingHttpHeaders
Returns IncomingHttpHeaders
- Defined in src/Request.ts:78

getHostname

getHostname(): string
Returns string
- Defined in src/Request.ts:195

getIP

getIP(): string
Returns string
- Defined in src/Request.ts:187

getMethod

getMethod(): string
Returns string
- Defined in src/Request.ts:199

getParam

getParam(name: string): string | string[]
Parameters
- name: string
Returns string | string[]
- Defined in src/Request.ts:148

getParams

getParams(): IParameterMap
Returns IParameterMap
- Defined in src/Request.ts:144

getQueryMultiVariable

getQueryMultiVariable(name: string): string[]
Parameters
- name: string
Returns string[]
- Defined in src/Request.ts:120

getQuerySingleVariable

getQuerySingleVariable(name: string): string
Parameters
- name: string
Returns string
- Defined in src/Request.ts:100

getQueryVariable

getQueryVariable(name: string): IQueryParamValue
Parameters
- name: string
Returns IQueryParamValue
- Defined in src/Request.ts:96

getQueryVariables

getQueryVariables(): IQueryParams
Returns IQueryParams
- Defined in src/Request.ts:92

getRequestSource

getRequestSource(): Request
Returns Request
- Defined in src/Request.ts:219

getURL

getURL(): string
Returns string
- Defined in src/Request.ts:203

getURLMultiParam

getURLMultiParam(name: string): string[]
Gets a URL parameter as string[]. This is a convenience method over getParam which returns a union.
Parameters
- name: string
Returns string[]
- Defined in src/Request.ts:174

getURLSingleParam

getURLSingleParam(name: string): string
Gets a URL parameter as string. If the value is multiple then only the first value is returned. This is a convenience method over getParam which returns a union.
Parameters
- name: string
Returns string
- Defined in src/Request.ts:157

isSecure

isSecure(): boolean
Returns boolean
- Defined in src/Request.ts:207

pipe

pipe(destination: Writable): Writable
Parameters
- destination: Writable
Returns Writable
- Defined in src/Request.ts:211

unpipe

unpipe(source: Writable): void
Parameters
- source: Writable
Returns void
- Defined in src/Request.ts:215