@rapidrest/service-core 1.0.0-rc.2 → 1.0.0-rc.21

package/docs/reference/type-aliases/UpdateObject.md

@@ -1,19 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / UpdateObject
-
-# Type Alias: UpdateObject\<T\>
-
-> **UpdateObject**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
-
-Defined in: [src/routes/ModelRoute.ts:82](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L82)
-
-A Partial type for a BaseEntity or SimpleEntity.
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`BaseEntity`](../classes/BaseEntity.md) \| [`SimpleEntity`](../classes/SimpleEntity.md)

package/docs/reference/type-aliases/WsUpgradeAuth.md

@@ -1,27 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / WsUpgradeAuth
-
-# Type Alias: WsUpgradeAuth
-
-> **WsUpgradeAuth** = (`req`) => [`WsUpgradeAuthResult`](WsUpgradeAuthResult.md)
-
-Defined in: [src/http/Router.ts:142](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L142)
-
-Optional pre-upgrade auth function for WebSocket routes. Called synchronously inside the uWS
-`upgrade` callback — before the WebSocket handshake completes. Returning `{ reject: true }`
-sends an HTTP 401 and skips the upgrade entirely. Returning `{}` falls through to the
-post-upgrade message-based LOGIN flow. Returning `{ user, ... }` pre-authenticates the
-connection so clients that can send an Authorization header skip the LOGIN step.
-
-## Parameters
-
-### req
-
-[`HttpRequest`](../interfaces/HttpRequest.md)
-
-## Returns
-
-[`WsUpgradeAuthResult`](WsUpgradeAuthResult.md)

package/docs/reference/type-aliases/WsUpgradeAuthResult.md

@@ -1,47 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / WsUpgradeAuthResult
-
-# Type Alias: WsUpgradeAuthResult
-
-> **WsUpgradeAuthResult** = `object`
-
-Defined in: [src/http/Router.ts:127](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L127)
-
-Result returned by a pre-upgrade WebSocket auth function.
-
-## Properties
-
-### authPayload?
-
-> `optional` **authPayload?**: `any`
-
-Defined in: [src/http/Router.ts:129](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L129)
-
-***
-
-### authToken?
-
-> `optional` **authToken?**: `string`
-
-Defined in: [src/http/Router.ts:130](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L130)
-
-***
-
-### reject?
-
-> `optional` **reject?**: `boolean`
-
-Defined in: [src/http/Router.ts:132](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L132)
-
-Set to `true` to reject the connection with HTTP 401 before the WebSocket handshake.
-
-***
-
-### user?
-
-> `optional` **user?**: `any`
-
-Defined in: [src/http/Router.ts:128](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/Router.ts#L128)