Interface: RequestWS

Defined in: service-core/src/http/uWS/WebSocket.ts:15

HTTP request type for handling WebSocket upgrade requests. Extends HttpRequest with WebSocket-specific properties set by the router after the WebSocket connection is opened.

Extends

• HttpRequest

Indexable

[key: string]: any

Allow arbitrary per-request properties (e.g. req.websocket, req.wsHandled).

Properties

authPayload?

optional authPayload?: any

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

Full decoded JWT payload, set by JWT auth middleware.

Inherited from

HttpRequest.authPayload

---

authToken?

optional authToken?: string

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

Raw JWT token string, set by JWT auth middleware.

Inherited from

HttpRequest.authToken

---

body

body: any

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

Inherited from

HttpRequest.body

---

cookies

cookies: Record<string, string>

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

Inherited from

HttpRequest.cookies

---

headers

headers: Record<string, string | string[] | undefined>

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

Inherited from

HttpRequest.headers

---

method

method: string

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

Inherited from

HttpRequest.method

---

params

params: Record<string, string>

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

Inherited from

HttpRequest.params

---

path

path: string

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

Inherited from

HttpRequest.path

---

query

query: Record<string, string | string[]>

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

Inherited from

HttpRequest.query

---

rawBody?

optional rawBody?: Buffer<ArrayBufferLike>

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

Inherited from

HttpRequest.rawBody

---

session?

optional session?: Record<string, any>

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

Populated by the optional session middleware (see SessionManager). Undefined when no session middleware is registered (i.e. the session config block is absent).

Inherited from

HttpRequest.session

---

signedCookies

signedCookies: Record<string, string>

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

Inherited from

HttpRequest.signedCookies

---

socket

socket: object

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

Minimal socket interface; populated with remote address for IP extraction.

remoteAddress?

optional remoteAddress?: string

Inherited from

HttpRequest.socket

---

url

url: string

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

Inherited from

HttpRequest.url

---

user?

optional user?: any

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

Set by JWT auth middleware after successful token verification.

Inherited from

HttpRequest.user

---

websocket

websocket: IWebSocketShim | undefined

Defined in: service-core/src/http/uWS/WebSocket.ts:19

The WebSocket shim for this connection. Set on open after the upgrade.

---

wsHandled

wsHandled: boolean

Defined in: service-core/src/http/uWS/WebSocket.ts:26

Indicates that the WebSocket handler has processed this connection and the connection should remain open. Set to true by wrapMiddleware when a decorated handler returns successfully.