Class HttpReq

The default implementation of IHttpReq.

Provides typed access to all request data sources — JSON body, form fields, path parameters, query parameters, headers, and the raw body.

Use HttpReq.fromWebReq to create an instance from a standard Web API Request object.

Type Param: TReqMethod

The HTTP method type.

Type Param: TReqJson

The type of the parsed JSON body.

Type Param: TReqFields

The type of the parsed form fields.

Type Param: TReqParams

The type of the parsed path parameters.

Type Param: TReqSearchParams

The type of the parsed query parameters.

Type Param: TReqHeaders

The type of the parsed headers.

Type Param: TReqFiles

The expected file upload definitions.

Type Param: TCookieData

A record mapping cookie names to their value types.

IMPORT_PATH: "@daiso-tech/core/http-router"

Implements

IHttpReq

Index

Accessors

method readableStream signal url webReq

Methods

[asyncIterator] arrayBuffer blob bytes rawCookies rawFormData rawHeaders rawJson rawParams rawSearchParams text withSchema fromWebReq test

Accessors

method

get method(): HttpMethod
Returns the HTTP method of the request (e.g. GET, POST).

Returns HttpMethod
Implementation of IHttpReq.method
- Defined in src/http-router/implementations/http-req.ts:460

readableStream

get readableStream(): null | ReadableStream<unknown>
The request body as a ReadableStream, or null if the body has already is not available (e.g. GET/HEAD requests).

Allows streaming the body in chunks via the Streams API.

Returns null | ReadableStream<unknown>
Implementation of IHttpReq.readableStream
- Defined in src/http-router/implementations/http-req.ts:448

signal

get signal(): AbortSignal
An AbortSignal that is aborted when the underlying request is cancelled or times out.

Handlers can listen to this signal to stop long-running work early when the client disconnects or the request reaches its deadline.

Returns AbortSignal
Implementation of IHttpReq.signal
- Defined in src/http-router/implementations/http-req.ts:452

url

get url(): string
Returns the full request URL as a string.

Returns string
Implementation of IHttpReq.url
- Defined in src/http-router/implementations/http-req.ts:464

webReq

get webReq(): Request
The underlying standard Web API Request object.

Useful for interoperability with third-party libraries that expect a native Request, such as better-auth.

Returns Request
Implementation of IHttpReq.webReq
- Defined in src/http-router/implementations/http-req.ts:540

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<unknown, any, any>
Returns AsyncIterator<unknown, any, any>
Implementation of IHttpReq.[asyncIterator]
- Defined in src/http-router/implementations/http-req.ts:438

arrayBuffer

arrayBuffer(): Promise<ArrayBuffer>
Reads the request body as an ArrayBuffer.

Returns Promise<ArrayBuffer>
Implementation of IHttpReq.arrayBuffer
- Defined in src/http-router/implementations/http-req.ts:528

blob

blob(): Promise<Blob>
Reads the request body as a Blob.

Returns Promise<Blob>
Implementation of IHttpReq.blob
- Defined in src/http-router/implementations/http-req.ts:536

bytes

bytes(): Promise<Uint8Array<ArrayBufferLike>>
Reads the request body as a Uint8Array.

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of IHttpReq.bytes
- Defined in src/http-router/implementations/http-req.ts:532

rawCookies

rawCookies(): Partial<Record<string, string>>
Returns the raw, parsed cookies as a string-to-string map.

Returns Partial<Record<string, string>>
Implementation of IHttpReq.rawCookies
- Defined in src/http-router/implementations/http-req.ts:456

rawFormData

rawFormData(): Promise<
Partial<Record<string, string | string[] | IHttpFile | IHttpFile[]>>,
>
Returns the raw unparsed FormData as a plain object, or an empty object if not present. Each field is either a string value or an IHttpFile instance for file uploads.

Returns Promise<Partial<Record<string, string | string[] | IHttpFile | IHttpFile[]>>>
Implementation of IHttpReq.rawFormData
- Defined in src/http-router/implementations/http-req.ts:472

rawHeaders

rawHeaders(): Partial<Record<string, string>>
Returns the raw unparsed headers, or empty object if not present.

Returns Partial<Record<string, string>>
Implementation of IHttpReq.rawHeaders
- Defined in src/http-router/implementations/http-req.ts:524

rawJson

rawJson(): Promise<unknown>
Returns the raw unparsed JSON body.

Returns Promise<unknown>
Implementation of IHttpReq.rawJson
- Defined in src/http-router/implementations/http-req.ts:468

rawParams

rawParams(): Partial<Record<string, string>>
Returns the raw unparsed path parameters, or empty object if not present.

Returns Partial<Record<string, string>>
Implementation of IHttpReq.rawParams
- Defined in src/http-router/implementations/http-req.ts:505

rawSearchParams

rawSearchParams(): Partial<Record<string, string | string[]>>
Returns the raw unparsed query parameters, or empty object if not present.

Returns Partial<Record<string, string | string[]>>
Implementation of IHttpReq.rawSearchParams
- Defined in src/http-router/implementations/http-req.ts:509

text

text(): Promise<string>
Reads the request body as plain text.

Returns Promise<string>
Implementation of IHttpReq.text
- Defined in src/http-router/implementations/http-req.ts:444

withSchema

withSchema<
    TReqJson = unknown,
    TReqFields extends
        Partial<Record<string, unknown>> = Partial<Record<string, unknown>>,
    TReqParams extends
        Partial<Record<string, unknown>> = Partial<Record<string, unknown>>,
    TReqSearchParams extends
        Partial<Record<string, unknown>> = Partial<Record<string, unknown>>,
    TReqHeaders extends
        Partial<Record<string, unknown>> = Partial<Record<string, unknown>>,
    TReqFiles extends
        Partial<Record<string, FileDef>> = Partial<Record<string, FileDef>>,
    TCookieData extends
        Partial<Record<string, string>> = Partial<Record<string, string>>,
>(
    schemas: HttpReqSchemas<
        TReqJson,
        TReqFields,
        TReqParams,
        TReqSearchParams,
        TReqHeaders,
        TReqFiles,
        TCookieData,
    >,
): IValidatedHttpReq<
    TReqJson,
    TReqFields,
    TReqParams,
    TReqSearchParams,
    TReqHeaders,
    TReqFiles,
    TCookieData,
>
Type Parameters
- TReqJson = unknown
- TReqFields extends Partial<Record<string, unknown>> = Partial<Record<string, unknown>>
- TReqParams extends Partial<Record<string, unknown>> = Partial<Record<string, unknown>>
- TReqSearchParams extends Partial<Record<string, unknown>> = Partial<Record<string, unknown>>
- TReqHeaders extends Partial<Record<string, unknown>> = Partial<Record<string, unknown>>
- TReqFiles extends Partial<Record<string, FileDef>> = Partial<Record<string, FileDef>>
- TCookieData extends Partial<Record<string, string>> = Partial<Record<string, string>>
Parameters
- schemas: HttpReqSchemas<
      TReqJson,
      TReqFields,
      TReqParams,
      TReqSearchParams,
      TReqHeaders,
      TReqFiles,
      TCookieData,
  >
Returns IValidatedHttpReq<
    TReqJson,
    TReqFields,
    TReqParams,
    TReqSearchParams,
    TReqHeaders,
    TReqFiles,
    TCookieData,
>
Implementation of IHttpReq.withSchema
- Defined in src/http-router/implementations/http-req.ts:544

`Static`fromWebReq

fromWebReq(settings: FromWebReqSettings): IHttpReq
Creates an HttpReq instance from a standard Web API Request object.
Parameters
- settings: FromWebReqSettings
Returns IHttpReq
A new IHttpReq instance wrapping the request.
- Defined in src/http-router/implementations/http-req.ts:216

`Static`test

test(settings: TestReqSettings): IHttpReq
Creates an HttpReq instance with synthetic data for testing.

Unlike HttpReq.fromWebReq, this method does not require a real Web API Request object. Instead, you provide mock values for path parameters, search parameters, headers, cookies, and body through TestReqSettings. The resulting HttpReq behaves identically to one created from a real request, including validation support.
Parameters
- settings: TestReqSettings
  Configuration for the test request, including mock data and optional validation schemas.
Returns IHttpReq
A new IHttpReq instance suitable for testing.
- Defined in src/http-router/implementations/http-req.ts:404

Class HttpReq

Type Param: TReqMethod

Type Param: TReqJson

Type Param: TReqFields

Type Param: TReqParams

Type Param: TReqSearchParams

Type Param: TReqHeaders

Type Param: TReqFiles

Type Param: TCookieData

Implements

Index

Accessors

Methods

Accessors

method

Returns HttpMethod

readableStream

Returns null | ReadableStream<unknown>

signal

Returns AbortSignal

url

Returns string

webReq

Returns Request

Methods

[asyncIterator]

Returns AsyncIterator<unknown, any, any>

arrayBuffer

Returns Promise<ArrayBuffer>

blob

Returns Promise<Blob>

bytes

Returns Promise<Uint8Array<ArrayBufferLike>>

rawCookies

Returns Partial<Record<string, string>>

rawFormData

Returns Promise<Partial<Record<string, string | string[] | IHttpFile | IHttpFile[]>>>

rawHeaders

Returns Partial<Record<string, string>>

rawJson

Returns Promise<unknown>

rawParams

Returns Partial<Record<string, string>>

rawSearchParams

Returns Partial<Record<string, string | string[]>>

text

Returns Promise<string>

withSchema

Type Parameters

Parameters

Returns IValidatedHttpReq< TReqJson, TReqFields, TReqParams, TReqSearchParams, TReqHeaders, TReqFiles, TCookieData,>

StaticfromWebReq

Parameters

Returns IHttpReq

Statictest

Parameters

Returns IHttpReq

Settings

On This Page

Returns IValidatedHttpReq<
TReqJson,
TReqFields,
TReqParams,
TReqSearchParams,
TReqHeaders,
TReqFiles,
TCookieData,
>

`Static`fromWebReq

`Static`test