covenix

Appearance

covenix / ResponseMetadata

Interface: ResponseMetadata ​

Defined in: src/metadata.ts:15

Everything declared for a single response status. Exactly one of schema (a JSON body from @Returns, possibly undefined for a no-content status like 204), file (a binary body from @ReturnsFile), or sse (a text/event-stream from @Sse) describes the body — declaring more than one for a status is an error. description/headers annotate it.

Properties ​

description? ​

optional description?: string

Defined in: src/metadata.ts:23

Response description (@Returns(..., { description })).

file? ​

optional file?: FileResponseDecl

Defined in: src/metadata.ts:19

@ReturnsFile binary body declaration.

headers? ​

optional headers?: Record<string, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>

Defined in: src/metadata.ts:25

Response headers (@Returns(..., { headers })), name → Zod schema.

schema? ​

optional schema?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:17

@Returns body schema; undefined means the status has no body.

sse? ​

optional sse?: SseResponseDecl

Defined in: src/metadata.ts:21

@Sse server-sent-events stream declaration.