covenix

Appearance

covenix / ResponseBaseOptions

Interface: ResponseBaseOptions ​

Defined in: src/response.ts:25

Options common to every covenix response envelope (ResponseBase).

Extended by ​

Properties ​

cookies? ​

optional cookies?: ResponseCookie[]

Defined in: src/response.ts:44

Cookies to set, each emitted as its own Set-Cookie header. Express formats them (encoding, Max-Age, SameSite, signing, …) — so you don't build the header string yourself.

headers? ​

optional headers?: Record<string, HeaderValue>

Defined in: src/response.ts:38

Extra response headers. Values may be strings, numbers, or arrays of them (an array repeats the header). A header that matches a @Returns(..., { headers }) schema is validated against it; undeclared headers are allowed.

status? ​

optional status?: number

Defined in: src/response.ts:31

Explicit HTTP status. Defaults to the route's declared success status (the first 2xx @Returns, or 200). When set, it must match one of the route's declared @Returns statuses.