Class Request<TBody, TAuthToken>

Type Parameters

TBody = any
TAuthToken extends IAuthTokenData = IAuthTokenData

Index

Constructors

Methods

getAuthenticationToken getBody getDatabasePosition getForm getForwardedIP getHeader getHeaders getHostname getIP getMethod getParam getParams getQueryVariables getRequestSource getURL isSecure pipe unpipe

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:44

Methods

getAuthenticationToken

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

getBody

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

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:141

getForm

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

getForwardedIP

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

getHeader

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

getHeaders

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

getHostname

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

getIP

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

getMethod

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

getParam

getParam(name: string): string
Parameters
- name: string
Returns string
- Defined in src/Request.ts:94

getParams

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

getQueryVariables

getQueryVariables(): any
Returns any
- Defined in src/Request.ts:86

getRequestSource

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

getURL

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

isSecure

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

pipe

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

unpipe

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