Skip to main content

Interface: HttpResponse

Defined in: service-core/src/http/types.ts:42

Framework-agnostic HTTP response interface. Mirrors the Express Response surface used throughout this codebase.

Indexable

[key: string]: any

Allow arbitrary per-response properties.

Properties

headersSent

headersSent: boolean

Defined in: service-core/src/http/types.ts:44


result?

optional result?: any

Defined in: service-core/src/http/types.ts:47

Intermediate result passed between middleware via res.result.


statusCode

statusCode: number

Defined in: service-core/src/http/types.ts:43


writableEnded

writableEnded: boolean

Defined in: service-core/src/http/types.ts:45

Methods

end()

end(data?): void

Defined in: service-core/src/http/types.ts:53

Parameters

data?

any

Returns

void


getHeader()

getHeader(key): string | undefined

Defined in: service-core/src/http/types.ts:50

Parameters

key

string

Returns

string | undefined


json()

json(data): void

Defined in: service-core/src/http/types.ts:51

Parameters

data

any

Returns

void


onFinish()

onFinish(handler): void

Defined in: service-core/src/http/types.ts:59

Registers a callback fired exactly once when the response actually completes — either a normal end() or client/stream abort. Does not delay or await end(). Used to persist request-scoped state (e.g. session data) after downstream handlers finish mutating it.

Parameters

handler

() => void | Promise<void>

Returns

void


send()

send(data?): void

Defined in: service-core/src/http/types.ts:52

Parameters

data?

any

Returns

void


setHeader()

setHeader(key, value): this

Defined in: service-core/src/http/types.ts:49

Parameters

key

string

value

string | number

Returns

this


status()

status(code): this

Defined in: service-core/src/http/types.ts:48

Parameters

code

number

Returns

this