Class HTTPConnectionContext

Basic HTTP connection information

Hierarchy (View Summary)

ConnectionContext
- HTTPConnectionContext

Implements

IHTTPConnectionContext

Index

Constructors

Properties

aborted request response sent trustProxy

Accessors

Methods

Constructors

constructor

new HTTPConnectionContext(
options: IHTTPConnectionContextOptions,
): HTTPConnectionContext
Parameters
- options: IHTTPConnectionContextOptions
Returns HTTPConnectionContext
Overrides ConnectionContext.constructor
- Defined in contexts/connections/http.ts:26

Properties

aborted

aborted: boolean = false

Is the request aborted

`Protected`request

request: HttpRequest

`Protected`response

response: HttpResponse

sent

sent: boolean = false

Has an answer been sent

`Protected`trustProxy

trustProxy: boolean

Accessors

ip

get ip(): string
Returns the connection ip addres

Returns string
Implementation of IHTTPConnectionContext.ip
- Defined in contexts/connections/http.ts:39

passkey

get passkey(): string | undefined
Returns the current URL path

Returns string | undefined
Implementation of IHTTPConnectionContext.passkey
- Defined in contexts/connections/http.ts:53

url

get url(): string
Returns the current URL path

Returns string
Implementation of IHTTPConnectionContext.url
- Defined in contexts/connections/http.ts:49

Methods

send

send(
payload: HTTPResponseUnion,
options: { action: TrackerAction; statusCode?: number },
): Promise<void>
Sends a response
Parameters
- payload: HTTPResponseUnion
- options: { action: TrackerAction; statusCode?: number }
Returns Promise<void>
Implementation of IHTTPConnectionContext.send
- Defined in contexts/connections/http.ts:57