Type Alias IValidatedHttpReq<TReqJson, TReqFields, TReqParams, TReqSearchParams, TReqHeaders, TReqFiles, TCookieData>

IValidatedHttpReq: {
    cookies(): TCookieData;
    cookies<
        TField extends string
        | number
        | symbol,
        TValue extends undefined | string,
    >(
        field: TField,
    ): UndefinedToNull<TValue>;
    fields(): Promise<TReqFields>;
    fields<TField extends string | number | symbol, TValue extends unknown>(
        field: TField,
    ): Promise<TValue>;
    files(): Promise<HttpReqFiles<TReqFiles>>;
    files<TField extends string | number | symbol>(
        field: TField,
    ): Promise<IHttpFileCollection>;
    headers(): TReqHeaders;
    headers<TField extends string | number | symbol, TValue extends unknown>(
        field: TField,
    ): UndefinedToNull<TValue>;
    json(): Promise<TReqJson>;
    params(): TReqParams;
    params<TField extends string | number | symbol, TValue extends unknown>(
        field: TField,
    ): UndefinedToNull<TValue>;
    searchParams(): TReqSearchParams;
    searchParams<
        TField extends string
        | number
        | symbol,
        TValue extends unknown,
    >(
        field: TField,
    ): UndefinedToNull<TValue>;
}

A validated, type-safe view of the incoming HTTP request.

Returned by withSchema, this type provides schema-validated access to all request data sources — JSON body, form fields, uploaded files, path parameters, query parameters, headers, and cookies — with full type inference from the provided schemas.

Each accessor method is overloaded: calling with no arguments returns the entire validated record, while passing a specific field name returns only that field's value (with null for undefined optional fields).

Type Parameters

TReqJson = unknown
The type of the parsed JSON body.
TReqFields extends ReqInputs = ReqInputs
The type of the parsed form fields.
TReqParams extends ReqInputs = ReqInputs
The type of the parsed path parameters.
TReqSearchParams extends ReqInputs = ReqInputs
The type of the parsed query parameters.
TReqHeaders extends ReqInputs = ReqInputs
The type of the parsed headers.
TReqFiles extends FileInputs = FileInputs
The expected file definitions.
TCookieData extends StringInputs = StringInputs
A record mapping cookie names to their value types.

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

Type declaration

cookies:function
- cookies(): TCookieData
- Parses and returns all cookies, validated and transformed by the cookie schema.
  
  Returns TCookieData
  - Defined in src/http-router/contracts/http-req.contract.ts:91
- cookies<
      TField extends string
      | number
      | symbol,
      TValue extends undefined | string,
  >(
      field: TField,
  ): UndefinedToNull<TValue>
- Retrieves a single validated cookie value by name.
  Type Parameters
  - TField extends string | number | symbol
    The name of the cookie.
  - TValue extends undefined | string
    The cookie value type.
  Parameters
  - field: TField
    The name of the cookie.
  Returns UndefinedToNull<TValue>
  The validated cookie value.
  - Defined in src/http-router/contracts/http-req.contract.ts:101
fields:function
- fields(): Promise<TReqFields>
- Parses and returns all form fields from Request.formData.
  
  Returns Promise<TReqFields>
  - Defined in src/http-router/contracts/http-req.contract.ts:116
- fields<TField extends string | number | symbol, TValue extends unknown>(
  field: TField,
  ): Promise<TValue>
- Retrieves a single form field by name from Request.formData.
  Type Parameters
  - TField extends string | number | symbol
    The name of the form field.
  - TValue extends unknown
    The form field value type.
  Parameters
  - field: TField
    The name of the form field.
  Returns Promise<TValue>
  - Defined in src/http-router/contracts/http-req.contract.ts:124
files:function
- files(): Promise<HttpReqFiles<TReqFiles>>
- Returns all validated uploaded files keyed by field name from Request.formData. Each field resolves to an IHttpFileCollection.
  
  Returns Promise<HttpReqFiles<TReqFiles>>
  - Defined in src/http-router/contracts/http-req.contract.ts:132
- files<TField extends string | number | symbol>(
  field: TField,
  ): Promise<IHttpFileCollection>
- Retrieves the validated uploaded file collection by field name from Request.formData.
  Type Parameters
  - TField extends string | number | symbol
    The name of the file field.
  Parameters
  - field: TField
    The name of the file field.
  Returns Promise<IHttpFileCollection>
  - Defined in src/http-router/contracts/http-req.contract.ts:139
headers:function
- headers(): TReqHeaders
- Parses and returns all request headers.
  
  Returns TReqHeaders
  - Defined in src/http-router/contracts/http-req.contract.ts:179
- headers<TField extends string | number | symbol, TValue extends unknown>(
  field: TField,
  ): UndefinedToNull<TValue>
- Retrieves a single header value by name.
  Type Parameters
  - TField extends string | number | symbol
    The name of the header.
  - TValue extends unknown
    The header value type.
  Parameters
  - field: TField
    The name of the header.
  Returns UndefinedToNull<TValue>
  - Defined in src/http-router/contracts/http-req.contract.ts:187
json:function
- json(): Promise<TReqJson>
- Parses and returns the JSON body.
  
  Returns Promise<TReqJson>
  - Defined in src/http-router/contracts/http-req.contract.ts:111
params:function
- params(): TReqParams
- Parses and returns all path parameters.
  
  Returns TReqParams
  - Defined in src/http-router/contracts/http-req.contract.ts:146
- params<TField extends string | number | symbol, TValue extends unknown>(
  field: TField,
  ): UndefinedToNull<TValue>
- Retrieves a single path parameter by name.
  Type Parameters
  - TField extends string | number | symbol
    The name of the path parameter.
  - TValue extends unknown
    The path parameter value type.
  Parameters
  - field: TField
    The name of the path parameter.
  Returns UndefinedToNull<TValue>
  - Defined in src/http-router/contracts/http-req.contract.ts:154
searchParams:function
- searchParams(): TReqSearchParams
- Parses and returns all query string parameters.
  
  Returns TReqSearchParams
  - Defined in src/http-router/contracts/http-req.contract.ts:161
- searchParams<TField extends string | number | symbol, TValue extends unknown>(
  field: TField,
  ): UndefinedToNull<TValue>
- Retrieves a single query string parameter by name.
  Type Parameters
  - TField extends string | number | symbol
    The name of the query parameter.
  - TValue extends unknown
    The query parameter value type.
  Parameters
  - field: TField
    The name of the query parameter.
  Returns UndefinedToNull<TValue>
  - Defined in src/http-router/contracts/http-req.contract.ts:169

Type Alias IValidatedHttpReq<TReqJson, TReqFields, TReqParams, TReqSearchParams, TReqHeaders, TReqFiles, TCookieData>

Type Parameters

Type declaration

cookies:function

Returns TCookieData

Type Parameters

Parameters

Returns UndefinedToNull<TValue>

fields:function

Returns Promise<TReqFields>

Type Parameters

Parameters

Returns Promise<TValue>

files:function

Returns Promise<HttpReqFiles<TReqFiles>>

Type Parameters

Parameters

Returns Promise<IHttpFileCollection>

headers:function

Returns TReqHeaders

Type Parameters

Parameters

Returns UndefinedToNull<TValue>

json:function

Returns Promise<TReqJson>

params:function

Returns TReqParams

Type Parameters

Parameters

Returns UndefinedToNull<TValue>

searchParams:function

Returns TReqSearchParams

Type Parameters

Parameters

Returns UndefinedToNull<TValue>

Settings