Skip to main content

Class: UWSResponse

Defined in: service-core/src/http/uWS/Adapters.ts:133

Adapts a uWS HttpResponse to the framework-agnostic HttpResponse interface.

Buffers headers and status code until the first write. Tracks abort state to safely skip writes on aborted connections. All uWS writes are wrapped in res.cork() for optimal performance.

Implements

Indexable

[key: string]: any

Allow arbitrary per-response properties.

Constructors

Constructor

new UWSResponse(uwsRes): UWSResponse

Defined in: service-core/src/http/uWS/Adapters.ts:151

Parameters

uwsRes

HttpResponse

Returns

UWSResponse

Properties

isHead

isHead: boolean = false

Defined in: service-core/src/http/uWS/Adapters.ts:145

Set to true for HEAD requests — body bytes must not be sent.


result?

optional result?: any

Defined in: service-core/src/http/uWS/Adapters.ts:147

Intermediate result passed between middleware.

Implementation of

HttpResponse.result

Accessors

headersSent

Get Signature

get headersSent(): boolean

Defined in: service-core/src/http/uWS/Adapters.ts:166

Returns

boolean

Implementation of

HttpResponse.headersSent


statusCode

Get Signature

get statusCode(): number

Defined in: service-core/src/http/uWS/Adapters.ts:162

Returns

number

Implementation of

HttpResponse.statusCode


writableEnded

Get Signature

get writableEnded(): boolean

Defined in: service-core/src/http/uWS/Adapters.ts:170

Returns

boolean

Implementation of

HttpResponse.writableEnded

Methods

end()

end(data?): void

Defined in: service-core/src/http/uWS/Adapters.ts:203

Parameters

data?

any

Returns

void

Implementation of

HttpResponse.end


flushHeaders()

flushHeaders(): void

Defined in: service-core/src/http/uWS/Adapters.ts:241

Flushes status and headers to the wire immediately without ending the response. Required before streaming data (e.g. SSE). Safe to call multiple times — only acts on the first call.

Returns

void


getHeader()

getHeader(key): string | undefined

Defined in: service-core/src/http/uWS/Adapters.ts:184

Parameters

key

string

Returns

string | undefined

Implementation of

HttpResponse.getHeader


json()

json(data): void

Defined in: service-core/src/http/uWS/Adapters.ts:188

Parameters

data

any

Returns

void

Implementation of

HttpResponse.json


onAbort()

onAbort(callback): void

Defined in: service-core/src/http/uWS/Adapters.ts:269

Registers a callback to run when the client aborts the connection. Safe to call multiple times — all registered callbacks are invoked on abort. Uses the single uWS onAborted slot registered in the constructor.

Parameters

callback

() => void

Returns

void


onFinish()

onFinish(handler): void

Defined in: service-core/src/http/uWS/Adapters.ts:279

Registers a callback fired exactly once when the response lifecycle ends — either a normal end() or a client abort. Fires immediately if the response has already finished. Handlers run fire-and-forget (via a resolved microtask) so slow/async work (e.g. a Redis write) never delays or blocks the actual response flush.

Parameters

handler

() => void | Promise<void>

Returns

void

Implementation of

HttpResponse.onFinish


send()

send(data?): void

Defined in: service-core/src/http/uWS/Adapters.ts:193

Parameters

data?

any

Returns

void

Implementation of

HttpResponse.send


setHeader()

setHeader(key, value): this

Defined in: service-core/src/http/uWS/Adapters.ts:179

Parameters

key

string

value

string | number

Returns

this

Implementation of

HttpResponse.setHeader


status()

status(code): this

Defined in: service-core/src/http/uWS/Adapters.ts:174

Parameters

code

number

Returns

this

Implementation of

HttpResponse.status


write()

write(data): void

Defined in: service-core/src/http/uWS/Adapters.ts:258

Writes a chunk to the response without ending it (streaming / SSE). Flushes headers on the first call if they haven't been sent yet.

Parameters

data

string | Buffer<ArrayBufferLike>

Returns

void