Core

struct.urlencoded

Object struct that is encoded as an URL-encoded form when it is the request body.

Chapter navigation

@defjs/core · Function

Signature

function urlencoded<T extends ObjectShape>(
  shape: T,
): ObjectStruct<T>;

Parses like struct.object(), and carries a urlencoded codec tag.

The tag applies only when this struct's value is the request body root. The body is then sent as URLSearchParams with application/x-www-form-urlencoded;charset=UTF-8.
Arrays repeat the field name and undefined fields are skipped. A nested object or a Blob fails the request with REQ_BUILD_FAILED.
struct.parse ignores the tag. It does not accept a URLSearchParams instance, only a plain object.

Prop

Type

shape T

struct.unknown

Struct that accepts any value except null and undefined, typed as unknown.

struct

Facade object for building protocol-boundary structs and parsing values with its constructors and struct.parse.