Class RequestContext<MiddlewareData>

Type Parameters

MiddlewareData extends Record<any, any> = any

Index

Constructors

Properties

aborted body chunked context cookies endFn error executeSelf file fragments global headers ip middlewareData middlewares params queries response route server started type url vary yielded

Methods

abort awaitBody data elapsed findRoute handleError setExecuteSelf

Constructors

constructor

new RequestContext<MiddlewareData>(context, middlewares, server, global): RequestContext<MiddlewareData>
Type Parameters
- MiddlewareData extends Record<any, any> = any
Parameters
- context: ImplementationHttpContext
- middlewares: UsableMiddleware[]
- server: Server<any, [], {}>
- global: GlobalContext
Returns RequestContext<MiddlewareData>
- Defined in src/types/internal/classes/RequestContext.ts:23

Properties

`Private` aborted

aborted: boolean = false

body

body: {
    awaiting: boolean;
    callbacks: ((raw) => void)[];
    chunks: Buffer<ArrayBufferLike>[];
    parsed: ParsedBody;
    raw: null | Buffer<ArrayBufferLike>;
    type: "raw" | "json" | "url-encoded";
} = ...

Body / Ws Message Data

Type declaration

awaiting: boolean
Whether the Body is being awaited

Since
9.0.0
callbacks: ((raw) => void)[]
Callbacks that get called when full body is resolved

Since
9.0.0
chunks: Buffer<ArrayBufferLike>[]
The Chunks of the Body

Since
9.0.0
parsed: ParsedBody
The Parsed Data of the Body

Since
9.0.0
raw: null | Buffer<ArrayBufferLike>
The Raw Data of the Body

Since
9.0.0
type: "raw" | "json" | "url-encoded"
The Type of the parsed Body

Since
9.0.0

Since

9.0.0

chunked

chunked: boolean = false

Whether the Request is chunked

Since

9.0.0

`Private` context

context: ImplementationHttpContext

cookies

cookies: null | ValueCollection<string, string, Cookie> = null

The Cookies of the Request

Since

9.0.0

endFn

endFn: boolean = false

Whether the EndFn was called

Since

9.0.0

error

error: null | RuntimeError = null

The Error this request encountered

Since

9.0.0

`Protected` executeSelf

executeSelf: (() => boolean | Promise<boolean>) = ...

Type declaration

- (): boolean | Promise<boolean>
- Returns boolean | Promise<boolean>

file

file: null | string = null

The File to print at the end of the request

Warn

Only used in static routes, do not use in other routes

Since

9.0.0

fragments

fragments: null | ValueCollection<string, string, string> = null

The Fragments of the Request

Since

9.0.0

global

global: GlobalContext

The Global Context

Since

9.0.0

headers

headers: ValueCollection<string, string, string>

The Headers of the URL Path

Since

9.0.0

ip

ip: {
    isInternal: boolean;
    isProxied: boolean;
    port: number;
    value: string;
}

IP Information

Type declaration

isInternal: boolean
Whether the IP is from an internal request

Since
9.3.0
isProxied: boolean
Whether the IP is Proxied

Since
9.0.0
port: number
The Port that the IP is using

Since
9.0.0
value: string
The Value of the IP

Since
9.0.0

Since

9.0.0

`Private` middlewareData

middlewareData: Record<string, any> = {}

`Private` middlewares

middlewares: UsableMiddleware[]

params

params: ValueCollection<string, string, string> = ...

The Params of the URL Path

Since

9.0.0

queries

queries: null | ValueCollection<string, string, string> = null

The Queries of the Request

Since

9.0.0

response

response: {
    content: Content;
    cookies: ValueCollection<string, Cookie, Cookie>;
    headers: ValueCollection<string, string, string>;
    prettify: boolean;
    status: number;
    statusText: null | string;
} = ...

The Response Data

Type declaration

content: Content
The Content to send
Default
```
[]
```
Since
9.0.0
cookies: ValueCollection<string, Cookie, Cookie>
The Cookies to add

Since
9.0.0
headers: ValueCollection<string, string, string>
The Headers to send

Since
9.0.0
prettify: boolean
Whether to prettify the content
Default
```
false
```
Since
9.0.0
status: number
The Status Code to send
Default
```
200
```
Since
9.0.0
statusText: null | string
The Status Text to send
Default
```
null
```
Since
9.0.0

Since

9.0.0

route

route: null | default<"http"> | default<"ws"> | default<"static"> = null

The Route, if found

Since

9.0.0

`Private` server

server: Server<any, [], {}>

Type declaration

`Private` started

started: number = ...

type

type: "http" | "ws"

The Type of the Request

Since

9.0.0

url

url: default

The URL Object

Since

9.0.0

vary

vary: Set<string> = ...

What headers affected the response (vary)

Since

9.3.4

yielded

yielded: null | default<unknown> = null

The Yielded Response

Since

9.2.0

Methods

abort

abort(ctr?): Promise<boolean>
Initiate Request Abortion
Parameters
- Optional ctr: HttpRequestContext<any>
Returns Promise<boolean>
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:135

awaitBody

awaitBody(ctr, concat?): Promise<Buffer<ArrayBufferLike>>
Await the Body
Parameters
- ctr: HttpRequestContext<any>
- concat: boolean = true
Returns Promise<Buffer<ArrayBufferLike>>
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:183

data

data(middleware): MiddlewareData
Retrieve Middleware Data
Parameters
- middleware: Middleware<{}, {}, typeof Dummy, typeof Dummy, typeof Dummy, typeof Dummy, []> | UsableMiddleware<any, any, any, any, any> | {
  use(...args): UsableMiddleware<any, any, any, any, any>;
  }
Returns MiddlewareData
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:173

elapsed

elapsed(reset?): number
Get the ms elapsed since the request started
Parameters
- reset: boolean = false
Returns number
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:220

findRoute

findRoute(method, path): null | default<"http"> | default<"ws">
Get the Route that matches the input
Parameters
- method: "CONNECT" | "TRACE" | "OPTIONS" | "DELETE" | "PATCH" | "HEAD" | "POST" | "PUT" | "GET"
- path: string
Returns null | default<"http"> | default<"ws">
Since
9.4.0
- Defined in src/types/internal/classes/RequestContext.ts:120

handleError

handleError(error, cause): RuntimeError
Handle an Error, automatically sets status and calls callback
Parameters
- error: unknown
- cause: string
Returns RuntimeError
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:111

setExecuteSelf

setExecuteSelf(callback): this
Set Code to execute at the end end of the request, return a boolean describing if you want the normal request end to proceed too
Parameters
- callback: (() => boolean | Promise<boolean>)
  - - (): boolean | Promise<boolean>
    - Returns boolean | Promise<boolean>
Returns this
Since
9.0.0
- Defined in src/types/internal/classes/RequestContext.ts:96

Class RequestContext<MiddlewareData>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RequestContext<MiddlewareData>

Properties

Private aborted

body

Type declaration

awaiting: boolean

Since

callbacks: ((raw) => void)[]

Since

chunks: Buffer<ArrayBufferLike>[]

Since

parsed: ParsedBody

Since

raw: null | Buffer<ArrayBufferLike>

Since

type: "raw" | "json" | "url-encoded"

Since

Since

chunked

Since

Private context

cookies

Since

endFn

Since

error

Since

Protected executeSelf

Type declaration

Returns boolean | Promise<boolean>

file

Warn

Since

fragments

Since

global

Since

headers

Since

ip

Type declaration

isInternal: boolean

Since

isProxied: boolean

Since

port: number

Since

value: string

Since

Since

Private middlewareData

Private middlewares

params

Since

queries

Since

response

Type declaration

content: Content

Default

Since

cookies: ValueCollection<string, Cookie, Cookie>

Since

headers: ValueCollection<string, string, string>

Since

prettify: boolean

Default

Since

status: number

Default

`Private` aborted

`Private` context

`Protected` executeSelf

`Private` middlewareData

`Private` middlewares

`Private` server

`Private` started