@rapidrest/service-core 1.0.0-beta.1 → 1.0.0-beta.2

package/docs/reference/classes/UWSResponse.md

@@ -0,0 +1,257 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / UWSResponse
+
+# Class: UWSResponse
+
+Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L109)
+
+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
+
+- [`HttpResponse`](../interfaces/HttpResponse.md)
+
+## Indexable
+
+> \[`key`: `string`\]: `any`
+
+Allow arbitrary per-response properties.
+
+## Constructors
+
+### Constructor
+
+> **new UWSResponse**(`uwsRes`): `UWSResponse`
+
+Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L123)
+
+#### Parameters
+
+##### uwsRes
+
+`HttpResponse`
+
+#### Returns
+
+`UWSResponse`
+
+## Properties
+
+### isHead
+
+> **isHead**: `boolean` = `false`
+
+Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L117)
+
+Set to true for HEAD requests — body bytes must not be sent.
+
+***
+
+### result?
+
+> `optional` **result?**: `any`
+
+Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L119)
+
+Intermediate result passed between middleware.
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`result`](../interfaces/HttpResponse.md#result)
+
+## Accessors
+
+### headersSent
+
+#### Get Signature
+
+> **get** **headersSent**(): `boolean`
+
+Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L135)
+
+##### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`headersSent`](../interfaces/HttpResponse.md#headerssent)
+
+***
+
+### statusCode
+
+#### Get Signature
+
+> **get** **statusCode**(): `number`
+
+Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L131)
+
+##### Returns
+
+`number`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`statusCode`](../interfaces/HttpResponse.md#statuscode)
+
+***
+
+### writableEnded
+
+#### Get Signature
+
+> **get** **writableEnded**(): `boolean`
+
+Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L139)
+
+##### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`writableEnded`](../interfaces/HttpResponse.md#writableended)
+
+## Methods
+
+### end()
+
+> **end**(`data?`): `void`
+
+Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L172)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`end`](../interfaces/HttpResponse.md#end)
+
+***
+
+### getHeader()
+
+> **getHeader**(`key`): `string` \| `undefined`
+
+Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L153)
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`getHeader`](../interfaces/HttpResponse.md#getheader)
+
+***
+
+### json()
+
+> **json**(`data`): `void`
+
+Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L157)
+
+#### Parameters
+
+##### data
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`json`](../interfaces/HttpResponse.md#json)
+
+***
+
+### send()
+
+> **send**(`data?`): `void`
+
+Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L162)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`send`](../interfaces/HttpResponse.md#send)
+
+***
+
+### setHeader()
+
+> **setHeader**(`key`, `value`): `this`
+
+Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L148)
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### value
+
+`string` \| `number`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`setHeader`](../interfaces/HttpResponse.md#setheader)
+
+***
+
+### status()
+
+> **status**(`code`): `this`
+
+Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L143)
+
+#### Parameters
+
+##### code
+
+`number`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`HttpResponse`](../interfaces/HttpResponse.md).[`status`](../interfaces/HttpResponse.md#status)