Class MoxyRequest

Hierarchy

IncomingMessage
- MoxyRequest

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MoxyRequest(socket: Socket): MoxyRequest

Overrides IncomingMessage.constructor
- Defined in server/request.ts:21
Parameters
- socket: Socket
Returns MoxyRequest

Properties

id

id: string

Unique request UUID

timestamp

timestamp: number

The unix timestamp of the request

Accessors

body

get body(): Promise<Buffer>

- Defined in server/request.ts:31
A promise which resolves to the request body

Returns Promise<Buffer>

path

get path(): string

- Defined in server/request.ts:58
Get the request path without hash or search

Returns string

query

get query(): ParsedUrlQuery

- Defined in server/request.ts:49
Get the parsed query params

Returns ParsedUrlQuery

Methods

getBody

getBody(format: "buffer"): Promise<Buffer>
getBody(format: "string"): Promise<string>
getBody(format: "json"): Promise<Record<string, any>>

- Defined in server/request.ts:67
Gets the body

Parameters
- format: "buffer"
  
  The desired body format (defaults to content-type header)
Returns Promise<Buffer>
- Defined in server/request.ts:68
Parameters
- format: "string"
Returns Promise<string>
- Defined in server/request.ts:69
Parameters
- format: "json"
Returns Promise<Record<string, any>>

parseBody

parseBody(body: Buffer): string | Record<string, any> | Buffer

- Defined in server/request.ts:91
Parse the body using conten-type header

Parameters
- body: Buffer
  
  The body
Returns string | Record<string, any> | Buffer

Generated using TypeDoc