typia.http.headers() is a function decoding an header instance, with automatic
type casting to the expected type. When property type be defined as boolean or
number type, typia.http.headers() will cast the value to the expected type.
By the way, as HTTP headers are not enough to express complex data structures,
typia.http.headers() function has some limitations. If target type T is not
following those restrictions, compilation errors would be occured.
Type T must be an object type
Do not allow dynamic property
Property key must be lower case
Property value cannot be null, but undefined is possible
Only boolean, bigint, number, string or their array types are allowed
By the way, union type never be not allowed
Property set-cookie must be array type
Those properties cannot be array type
age
authorization
content-length
content-type
etag
expires
from
host
if-modified-since
if-unmodified-since
last-modified
location
max-forwards
proxy-authorization
referer
retry-after
server
user-agent
Also, typia.http.headers() function does not perform validation about the decoded
value. Therefore, if you can't sure that input data is following the T type,
it would better to call one of below functions intead.
Headers decoder (for express and fastify).
typia.http.headers()
is a function decoding an header instance, with automatic type casting to the expected type. When property type be defined asboolean
ornumber
type,typia.http.headers()
will cast the value to the expected type.By the way, as HTTP headers are not enough to express complex data structures,
typia.http.headers()
function has some limitations. If target typeT
is not following those restrictions, compilation errors would be occured.T
must be an object typenull
, butundefined
is possibleboolean
,bigint
,number
,string
or their array types are allowedset-cookie
must be array typeAlso,
typia.http.headers()
function does not perform validation about the decoded value. Therefore, if you can't sure that input data is following theT
type, it would better to call one of below functions intead.