Packages@robojs/server
RoboRequest
Class: RoboRequest
Extends the Web Request API with additional convenience methods.
Extends
Request
Properties
| Property | Type |
|---|---|
[INTERNALS] | { params: Record<string, string>; raw: IncomingMessage; } |
[INTERNALS].params | Record<string, string> |
[INTERNALS].raw | IncomingMessage |
Accessors
params
Get Signature
get params(): Record<string, string>Returns
Record<string, string>
query
Get Signature
get query(): Record<string, string | string[]>Returns
Record<string, string | string[]>
raw
Get Signature
get raw(): IncomingMessageReturns
IncomingMessage
Methods
forTesting()
static forTesting(options): RoboRequestCreates a RoboRequest for testing purposes without requiring an IncomingMessage. This factory method allows creating fully-functional RoboRequest instances with params, query, headers, and body for unit testing API handlers.
Parameters
| Parameter | Type |
|---|---|
options | ForTestingOptions |
Returns
Example
const request = RoboRequest.forTesting({
method: 'POST',
path: '/users',
params: { id: '123' },
query: { include: 'profile' },
body: { name: 'John' }
})
const response = await handler(request)from()
static from(req, options?): Promise<RoboRequest>Parameters
| Parameter | Type |
|---|---|
req | IncomingMessage |
options? | FromOptions |
Returns
Promise<RoboRequest>